Migrate to Polaris
Version 2025-07 is the last API version to support React-based UI components. Later versions use web components, native UI elements with built-in accessibility, better performance, and consistent styling with Shopify's design system. Check out the migration guide to upgrade your extension.
Checkout Token API
The API for interacting with the token of a checkout.
Anchor to standardapiStandardApi
The base API object provided to purchase extension targets.
- Anchor to checkoutTokencheckoutTokencheckoutTokenStatefulRemoteSubscribable<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
use
Returns a stable id that represents the current checkout.
CheckoutToken | undefinedCheckoutToken | undefined
CheckoutToken
string
Was this page helpful?