Skip to content
Create account or Sign in
The Stripe Docs logo
/
Create accountSign in

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

ValueChangeEnums
customAdded
Checkout.Session#create.ui_modeCheckout.Session.ui_mode

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

Was this page helpful?
YesNo