Version 2025-07 is the last API version to support React-based UI components. Later versions use Polaris web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the upgrade guide to upgrade your extension and avoid being blocked from updating your extension after October 1st 2026.
Checkout Token API
The API for interacting with the token of a checkout.
Anchor to StandardApiStandard
The base API object provided to purchase extension targets.
- Anchor to checkoutTokencheckout
Tokencheckout Token StatefulRemoteSubscribable<CheckoutToken | undefined>StatefulRemoteSubscribable<CheckoutToken | undefined>requiredrequired A stable ID that represents the current checkout.
Matches the
tokenfield in the WebPixel checkout payload and thefield in the REST Admin APIOrderresource.
CheckoutToken
stringAnchor to useCheckoutTokenuse
A stable id that represents the current checkout.
Matches the token field in the WebPixel checkout payload and the field in the Admin REST API Order resource.
