Create a shipping rate 

Creates a new shipping rate object.

Parameters

• display_namestringRequired

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

• fixed_amountobject

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

  Hide child parameters

  • fixed_amount.amountintegerRequired

    A non-negative integer in cents representing how much to charge.

  • fixed_amount.currencyenumRequired

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

  • fixed_amount.currency_optionsobject

    Shipping rates defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

    Hide child parameters

    • fixed_amount.currency_options.<currency>.amountintegerRequired

      A non-negative integer in cents representing how much to charge.

    • fixed_amount.currency_options.<currency>.tax_behaviorenumRecommended if calculating taxes

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

      Possible enum values

      exclusive

      inclusive

      unspecified

• metadataobject

  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.

• tax_behaviorenumRecommended if calculating taxes

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

  Possible enum values

  exclusive

  inclusive

  unspecified

• tax_codestringRecommended if calculating taxes

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

• typeenumRequired

  The type of calculation to use on the shipping rate.

  Possible enum values

  fixed_amount The shipping rate is a fixed amount.

More parameters

Collapse all

• delivery_estimateobject

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

  Hide child parameters

  • delivery_estimate.maximumobject

    The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.

    Hide child parameters

    • delivery_estimate.maximum.unitenumRequired

      A unit of time.

      Possible enum values

      business_day The delivery estimate is in business days.

      day The delivery estimate is in days.

      hour The delivery estimate is in hours.

      month The delivery estimate is in months.

      week The delivery estimate is in weeks.

    • delivery_estimate.maximum.valueintegerRequired

      Must be greater than 0.

  • delivery_estimate.minimumobject

    The lower bound of the estimated range. If empty, represents no lower bound.

    Hide child parameters

    • delivery_estimate.minimum.unitenumRequired

      A unit of time.

      Possible enum values

      business_day The delivery estimate is in business days.

      day The delivery estimate is in days.

      hour The delivery estimate is in hours.

      month The delivery estimate is in months.

      week The delivery estimate is in weeks.

    • delivery_estimate.minimum.valueintegerRequired

      Must be greater than 0.