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
createdfield. 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" } ]}