CheckoutShippingRate

Resolved shipping rate object for a Checkout Session.

  • id
    Type: string
    required

    Shipping rate ID. Pass this value as shipping_rate when updating a Checkout Session.

  • display_name
    Type: string
    required

    Customer-facing shipping option name.

  • type
    enum
    const:  
    fixed_amount
    required
    values
    • fixed_amount

      Shipping is charged as a fixed amount.

  • fixed_amount
    Type: CheckoutShippingFixedAmountnullable
    Properties: 2
  • delivery_estimate
    Type: CheckoutDeliveryEstimatenullable
    Properties: 2
  • tax_behavior
    Type: CheckoutShippingTaxBehaviorenum
    values
    • unspecified

      No tax behavior has been specified for the shipping rate.

    • exclusive

      Tax is added on top of the shipping amount.

    • inclusive

      Tax is included in the shipping amount.

  • tax_code
    Type: string | null

    Optional tax code for this shipping rate.

  • metadata
    nullable

    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.

    • propertyName
      additionalPropertyType: string
  • active
    Type: boolean
    required

    Whether this shipping rate is currently selected for the Checkout Session.