Mayson Monorepo Documentation
    Preparing search index...

    Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.

    interface ShippingRate {
        id: string;
        object: "shipping_rate";
        active: boolean;
        created: number;
        delivery_estimate: Stripe.ShippingRate.DeliveryEstimate;
        display_name: string;
        fixed_amount?: Stripe.ShippingRate.FixedAmount;
        livemode: boolean;
        metadata: Metadata;
        tax_behavior: Stripe.ShippingRate.TaxBehavior;
        tax_code: string | TaxCode;
        type: "fixed_amount";
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "shipping_rate"

    String representing the object's type. Objects of the same type share the same value.

    active: boolean

    Whether the shipping rate can be used for new purchases. Defaults to true.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

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

    display_name: string

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

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    metadata: Metadata

    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.

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

    tax_code: string | TaxCode

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

    type: "fixed_amount"

    The type of calculation to use on the shipping rate.