Update a shipping rate

POST / v1 / shipping_rates /:id

Updates an existing shipping rate object.

Parameters

active boolean Whether the shipping rate can be used for new purchases. Defaults to true.
fixed _ amount object Describes a fixed amount to charge for shipping. Must be present if type is fixed_amount.
metadata map 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 _ behavior enum Recommended 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

Returns

Returns the modified shipping rate object if the call succeeded.

Response

{ "id": "shr_1MrRx2LkdIwHu7ixikgEA6Wd", "object": "shipping_rate", "active": true, "created": 1680207604, "delivery_estimate": null, "display_name": "Ground shipping", "fixed_amount": { "amount": 500, "currency": "usd" }, "livemode": false, "metadata": { "order_id": "6735" }, "tax_behavior": "unspecified", "tax_code": null, "type": "fixed_amount"}

Retrieve a shipping rate

GET / v1 / shipping_rates /:id

Returns the shipping rate object with the given ID.

Parameters

No parameters.

Returns

Returns a shipping rate object if a valid identifier was provided.

Response

{ "id": "shr_1MrRx2LkdIwHu7ixikgEA6Wd", "object": "shipping_rate", "active": true, "created": 1680207604, "delivery_estimate": null, "display_name": "Ground shipping", "fixed_amount": { "amount": 500, "currency": "usd" }, "livemode": false, "metadata": {}, "tax_behavior": "unspecified", "tax_code": null, "type": "fixed_amount"}

List all shipping rates

GET / v1 / shipping_rates

Returns a list of your shipping rates.

Parameters

active boolean Only return shipping rates that are active or inactive.
created object 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.
currency enum Only return shipping rates for the given currency.

More parameters

ending _ before string
limit integer
starting _ after string

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 request should never raise an error.

Response

{ "object": "list", "url": "/v1/shipping_rates", "has_more": false, "data": [ { "id": "shr_1MrRx2LkdIwHu7ixikgEA6Wd", "object": "shipping_rate", "active": true, "created": 1680207604, "delivery_estimate": null, "display_name": "Ground shipping", "fixed_amount": { "amount": 500, "currency": "usd" }, "livemode": false, "metadata": {}, "tax_behavior": "unspecified", "tax_code": null, "type": "fixed_amount" } ]}