Breaking changes
Updates Checkout Session shipping properties Breaking changes
What’s new
Updates several Checkout Session resource shipping properties:
- Moves shipping _ rate into the new shipping _ cost hash.
- Renames shipping to shipping _ details .
Impact
Lets you clearly differentiate between the shipping rate information and the broader shipping details. By separating shipping_rate into its own shipping_cost hash, and renaming shipping to shipping_details, you can more granularly access and manage various shipped-related properties within a Checkout Session.
Changes
| Parameters | Change | Resources or endpoints |
|---|---|---|
| shipping_cost shipping_details | Added | Checkout. Session |
| shipping shipping_rate | Removed | Checkout. Session |
Upgrade
- View your current API version in Workbench.
- 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: 2022-08-01
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
- In Workbench, perform the upgrade . You can roll back the version for 72 hours.
Learn more about Stripe API upgrades.