Adds custom UI mode to Checkout Sessions
What’s new
Adds a custom enum for the ui_mode property. This option enables you to integrate Elements with the Checkout Sessions API.
Impact
The custom ui_mode is a new option that enables you to build a checkout page using Elements and the Checkout Sessions API. This integration manages tax, discounts, shipping and currency conversion.
Changes
| Value | Change | Enums |
|---|---|---|
| custom | Added | Checkout.Session#create.ui_mode Checkout.Session.ui_mode |
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: 2025-03-31. basil
- 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.