v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a shipping rate

Returns the shipping rate object with the given ID.

get/v1/shipping_rates/{shipping_rate_token}

Path parameters

shipping_rate_tokenstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

activeboolean required

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

createdinteger required

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

display_namestring nullable

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'shipping_rate' required

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

tax_behavior'exclusive' | 'inclusive' | 'unspecified' nullable

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

type'fixed_amount' required

The type of calculation to use on the shipping rate.