The Shipping Rate object 

Attributes

• idstring

  Unique identifier for the object.

• activeboolean

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

• display_namenullable string

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

• fixed_amountnullable object

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

  Hide child attributes

  • fixed_amount.amountinteger

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

  • fixed_amount.currencyenum

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

  • fixed_amount.currency_optionsnullable objectExpandable

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

    Hide child attributes

    • fixed_amount.currency_options.<currency>.amountinteger

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

    • fixed_amount.currency_options.<currency>.tax_behaviorenum

      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.

• tax_behaviornullable enum

  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_codenullable stringExpandable

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

• typeenum

  The type of calculation to use on the shipping rate.

  Possible enum values

  fixed_amount The shipping rate is a fixed amount.

More attributes

Collapse all

• objectstring

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

• createdtimestamp

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

• delivery_estimatenullable object

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

  Hide child attributes

  • delivery_estimate.maximumnullable object

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

    Hide child attributes

    • delivery_estimate.maximum.unitenum

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

      Must be greater than 0.

  • delivery_estimate.minimumnullable object

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

    Hide child attributes

    • delivery_estimate.minimum.unitenum

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

      Must be greater than 0.

• livemodeboolean

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