Breaking changes

Checkout Session removes shipping details Breaking changes

What’s new

Within a Checkout Session, the shipping_details top-level field has moved to the collected_information.shipping_details field.

Why is this a breaking change?

This change breaks compatibility because we’re removing the shipping_details field to the collected_information sub-hash on the same Checkout Session resource. Update your integration to reflect the new field name.

Impact

This change affects how you access shipping information on the Checkout Session resource: it improves how the API resource is organized, grouping related information more logically. By moving shipping details into the collected_information object, it becomes clearer that the customer provided this information as part of the checkout process.

To adopt this change:

1. Review your code that interacts with the Checkout Session resource.
2. Identify any instances where you’re accessing the shipping _ details field.
3. Update these instances to use collected _ information['shipping _ details'] instead.

Changes

Upgrade

1. View your current API version in Workbench.
2. If you use an SDK, upgrade to the corresponding SDK version for this API version.

• If you don’t use an SDK, update your API requests to include Stripe-Version: 2025-03-31. basil

3. Upgrade the API version used for webhook endpoints .
4. Test your integration against the new version.
5. If you use Connect, test your Connect integration .
6. In Workbench, perform the upgrade . You can roll back the version for 72 hours.

Learn more about Stripe API upgrades.

Related changes

• Checkout Sessions have lower latency and new update semantics
• Checkout Session allows shipping option updates
• Adds permissions parameter to Checkout Sessions
• Adds optional items to Checkout Sessions and Payment Links