Checkout Session removes shipping detailsBreaking 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