---
title: Checkout Token API
description: The API for interacting with the token of a checkout.
api_version: 2025-07
api_name: checkout-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-07/target-apis/checkout-apis/checkout-token-api
  md: >-
    https://shopify.dev/docs/api/checkout-ui-extensions/2025-07/target-apis/checkout-apis/checkout-token-api.md
---

Migrate to Polaris

Version 2025-07 is the last API version to support React-based UI components. Later versions use [web components](https://shopify.dev/docs/api/checkout-ui-extensions/latest/polaris-web-components), native UI elements with built-in accessibility, better performance, and consistent styling with [Shopify's design system](https://shopify.dev/docs/apps/design). Check out the [migration guide](https://shopify.dev/docs/api/checkout-ui-extensions/2026-04-rc/upgrading-to-2026-04) to upgrade your extension.

# Checkout Token API

The API for interacting with the token of a checkout.

## StandardApi

The base API object provided to `purchase` extension targets.

* **checkoutToken**

  **StatefulRemoteSubscribable\<CheckoutToken | undefined>**

  **required**

  A stable ID that represents the current checkout.

  Matches the `token` field in the [WebPixel checkout payload](https://shopify.dev/docs/api/pixels/customer-events#checkout) and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).

### CheckoutToken

```ts
string
```

## use​Checkout​Token()

Returns a stable id that represents the current checkout.

### Returns

* **CheckoutToken | undefined**

### CheckoutToken

```ts
string
```

## Related

[Reference - Targets](https://shopify.dev/docs/api/checkout-ui-extensions/targets)

[Reference - Components](https://shopify.dev/docs/api/checkout-ui-extensions/components)

[Reference - Configuration](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)

[Learn - Tutorials](https://shopify.dev/apps/checkout)