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
. - 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.
- typeenum
The type of calculation to use on the shipping rate. Can only be
fixed_amount
for now.
More attributes
- objectstring
- createdtimestamp
- delivery_
estimatenullable object - livemodeboolean
- tax_
behaviornullable enum - tax_
codenullable stringExpandable
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
. - 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
. - typeenumRequired
The type of calculation to use on the shipping rate. Can only be
fixed_amount
for now.
More parameters
- delivery_
estimateobject - tax_
behaviorenum - tax_
codestring
Returns
Returns a shipping rate object if the call succeeded.
Update a shipping rate
Updates an existing shipping rate object.
Parameters
- activeboolean
Whether the shipping rate can be used for new purchases. Defaults to
true
. - fixed_
amountobject Describes a fixed amount to charge for shipping. Must be present if type is
fixed_amount
. - 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
.
More parameters
- tax_
behaviorenum
Returns
Returns the modified shipping rate object if the call succeeded.
Retrieve a shipping rate
Returns the shipping rate object with the given ID.
Parameters
No parameters.
Returns
Returns a shipping rate object if a valid identifier was provided.
List all shipping rates
Returns a list of your shipping rates.
Parameters
- activeboolean
Only return shipping rates that are active or inactive.
- createdobject
A filter on the list, based on the object
created
field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options. - currencyenum
Only return shipping rates for the given currency.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
shipping rates, starting after shipping rate starting_after
. Each entry in the array is a separate shipping rate object. If no more shipping rates are available, the resulting array will be empty. This require should never raise an error.