CheckoutShippingRateData

Inline shipping rate data used to create a Checkout Session shipping rate.

  • delivery_estimate
    Type: object · CheckoutDeliveryEstimate nullable
    • maximum
      Type: object · CheckoutDeliveryEstimateBound nullable
    • minimum
      Type: object · CheckoutDeliveryEstimateBound nullable
  • display_name
    Type: string

    Customer-facing shipping option name.

  • fixed_amount
    Type: object · CheckoutShippingFixedAmount nullable
    • amount
      Type: integer · amountWithCurrencyPrecisionFormat: int64
      required

      Integer amount in minor units (e.g. cents) specific to the currency. Example: 100 for €1.00

    • currency
      Type: string · CurrencyCode
      required

      ISO 4217 currency codes (alpha3) supported for payments

  • 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.

    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
      Type: string
  • tax_behavior
    Type: string · 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.

  • type
    enum
    const:  
    fixed_amount
    values
    • fixed_amount

      Shipping is charged as a fixed amount.