Skip to main content
Manja / Stripe
Schema2020-08-27object

shipping_rate

Shipping rates describe the price of shipping presented to your customers and can be applied to [Checkout Sessions](https://stripe.com/docs/payments/checkout/shipping) to collect shipping costs.

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

ShippingRate

object

Shipping rates describe the price of shipping presented to your customers and can be applied to [Checkout Sessions](https://stripe.com/docs/payments/checkout/shipping) to collect shipping costs.

active boolean
required

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

created integer (unix-time)
required

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

delivery_estimate
optionalnullable

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

display_name string
optionalnullable

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

maxLength:5000

id string
required

Unique identifier for the object.

maxLength:5000

livemode boolean
required

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

metadata object
required

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

object string
required

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

Allowed: "shipping_rate"

tax_behavior string
optionalnullable

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

Allowed: "exclusive""inclusive""unspecified"

tax_code
optionalnullable

A [tax code](https://stripe.com/docs/tax/tax-codes) ID. The Shipping tax code is `txcd_92010001`.

type string
required

The type of calculation to use on the shipping rate. Can only be `fixed_amount` for now.

Allowed: "fixed_amount"