GET
/v1/shipping_ratesList shipping rates
Lists shipping rates available to your account. Filter the collection by active state, creation time, or currency, and use cursor parameters to retrieve adjacent pages. Each result contains shipping price and presentation details for use with purchases.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
activebooleanoptional
Filters shipping rates by whether they are active or inactive.
createdobjectoptional
Filters rates by their Unix creation timestamp or by range conditions such as `gt`, `gte`, `lt`, or `lte`.
currencystringoptional
Filters shipping rates by currency; the value must use the currency format.
ending_beforestringoptional
A cursor identifying the shipping rate before which to retrieve the previous page.
expandarray<string>optional
Fields to expand in each response object; each field name must not exceed 5,000 characters.
limitintegeroptional
The number of shipping rates to return. Must be between 1 and 100 and defaults to 10 when omitted.
starting_afterstringoptional
A cursor identifying the shipping rate after which to retrieve the next page.
200Returns a list object containing shipping-rate objects, a `has_more` indicator, the list object type, and the collection URL.
dataarray<ShippingRate>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
limit must be between 1 and 100 and defaults to 10 when omitted. currency must use the currency format, and starting_after or ending_before must identify a shipping-rate object when used for cursor pagination.