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

# Checkout Token

The API for interacting with the token of a checkout.

## StandardApi

The base API object provided to `purchase`, and `customer-account.order-status` 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 [Admin REST 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)