Choose a version:

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 checkoutToken checkoutToken < | undefined> required: A stable ID that represents the current checkout.

This matches the data.checkout.token field in a checkout-related WebPixel event and the checkout_token field in the REST Admin API Order resource.

SubscribableSignalLike

Represents a read-only value managed on the main thread that an extension can subscribe to. Example: Checkout uses this to manage the state of an object and communicate state changes to extensions running in a sandboxed web worker. This interface is compatible with [Preact's ReadonlySignal](https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709). Some fields are deprecated but still supported for backwards compatibility. In version 2025-10, [`StatefulRemoteSubscribable`](https://github.com/Shopify/remote-dom/blob/03929aa8418a89d41d294005f219837582718df8/packages/async-subscription/src/types.ts#L17) was replaced with `ReadonlySignalLike`. Checkout will remove the old fields some time in the future.

current
```
T
```
destroy
```
() => Promise<void>
```
subscribe
```
(fn: (value: T) => void) => () => void
```
value
```
T
```

export interface SubscribableSignalLike<T> extends ReadonlySignalLike<T> { /** * @deprecated Use `.value` instead. */ readonly current: T; /** * @deprecated No longer needed. Use Preact Signal management instead. */ destroy(): Promise<void>; }