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.

GET /v1/shipping_rates/:id
curl https://api.stripe.com/v1/shipping_rates/shr_1MrRx2LkdIwHu7ixikgEA6Wd \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
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 

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.

GET /v1/shipping_rates
curl -G https://api.stripe.com/v1/shipping_rates \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
-d limit=3
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"
}
]
}

Checkout Sessions 

A Checkout Session represents your customer’s session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.

Once payment is successful, the Checkout Session will contain a reference to the Customer, and either the successful PaymentIntent or an active Subscription.

You can create a Checkout Session on your server and redirect to its URL to begin Checkout.

Related guide: Checkout quickstart

Credit Note