Mayson Monorepo Documentation
    Preparing search index...

    Interface ShippingRateCreateParams

    interface ShippingRateCreateParams {
        display_name: string;
        delivery_estimate?: Stripe.ShippingRateCreateParams.DeliveryEstimate;
        expand?: string[];
        fixed_amount?: Stripe.ShippingRateCreateParams.FixedAmount;
        metadata?: MetadataParam;
        tax_behavior?: Stripe.ShippingRateCreateParams.TaxBehavior;
        tax_code?: string;
        type?: "fixed_amount";
    }
    Index

    Properties

    display_name: string

    The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.

    The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.

    metadata?: MetadataParam

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.

    tax_code?: string

    A tax code ID. The Shipping tax code is txcd_92010001.

    type?: "fixed_amount"

    The type of calculation to use on the shipping rate.