- Breaking changes
- Public preview
Renames the tax IDs property to tax ID in Checkout Session collected information Breaking changes Public preview
What’s new
Renames the tax_ids property on the collected_information hash of a Checkout Session from tax_ids (an array) to tax_id (a single object).
Previously, collected_information.tax_ids returned an array of tax ID objects. On newer API versions, collected_information.tax_id returns a single tax ID object, or null if no tax ID was collected.
Why is this a breaking change?
On API versions that include this change, the collected_information.tax_ids array property no longer exists and is replaced by collected_information.tax_id, a single object. If your integration reads collected_information.tax_ids and iterates over the array, you must update your code to read collected_information.tax_id as a single object instead. On older API versions, a compatibility layer continues to return tax_ids as a single-element array.
Impact
If your integration accesses collected_information.tax_ids on a Checkout Session response, you must update it to use collected_information.tax_id instead. Rather than iterating over an array, read the property directly as a single tax ID object (or handle null if no tax ID was collected).
Changes
| Parameters | Change | Resources or endpoints |
|---|---|---|
| tax_id | Added | Checkout. Session. collected_information |
| tax_ids | Removed | Checkout. Session. collected_information |
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: 2026-07-29. preview
- Upgrade the API version used for webhook endpoints .
- Test your integration against the new version.
- If you use Connect, test your Connect integration .
Learn more about Stripe API upgrades.