---
title: Settings
description: The API for interacting with merchant settings.
api_version: 2025-10
api_name: customer-account-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/customer-account-ui-extensions/latest/apis/order-status-api/settings
  md: https://shopify.dev/docs/api/customer-account-ui-extensions/latest/apis/order-status-api/settings.md
---

# SettingsAPI

The API for interacting with merchant settings.

## StandardApi

The base API object provided to this and other `customer-account` extension targets.

* settings

  SubscribableSignalLike\<ExtensionSettings>

  required

  The settings matching the settings definition written in the [`shopify.ui.extension.toml`](https://shopify.dev/docs/api/customer-account-ui-extensions/configuration) file.

  See [settings examples](https://shopify.dev/docs/api/customer-account-ui-extensions/apis/order-status-api/settings#examples) for more information.

  Note

  When an extension is being installed in the editor, the settings will be empty until a merchant sets a value. In that case, this object will be updated in real time as a merchant fills in the settings.

### 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

  ```ts
  T
  ```

* destroy

  ```ts
  () => Promise<void>
  ```

* subscribe

  ```ts
  (fn: (value: T) => void) => () => void
  ```

* value

  ```ts
  T
  ```

```ts
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>;
}
```

### ExtensionSettings

The merchant-defined setting values for the extension.

* \[key: string]

  ```ts
  string | number | boolean | undefined
  ```

```ts
export interface ExtensionSettings {
  [key: string]: string | number | boolean | undefined;
}
```

### Examples

* #### Extension.jsx

  ##### Default

  ```jsx
  import '@shopify/ui-extensions/preact';
  import {render} from 'preact';

  export default async () => {
    render(<Extension />, document.body);
  };

  function Extension() {
    const bannerTitle =
      shopify.settings.value?.banner_title || '';

    return <s-banner title={bannerTitle} />;
  }
  ```

## Examples

Define merchant settings

You can define settings that merchants can edit within the checkout editor. See [settings](https://shopify.dev/docs/api/customer-account-ui-extensions/configuration#settings-definition) for more information on how to define these.

### Examples

* #### Define merchant settings

  ##### Description

  You can define settings that merchants can edit within the checkout editor. See \[settings]\(/docs/api/customer-account-ui-extensions/configuration#settings-definition) for more information on how to define these.

  ##### shopify.extension.toml

  ```toml
  api_version = "unstable"

  [[extensions]]
  name = "My customer account ui extension"
  handle = "customer-account-ui"
  type = "ui_extension"

    [[extensions.targeting]]
    target = "customer-account.order-status.block.render"
    module = "./Extension.jsx"

    [extensions.settings]
      [[extensions.settings.fields]]
      key = "banner_title"
      type = "single_line_text_field"
      name = "Banner title"
      description = "Enter a title for the banner."
      [[extensions.settings.fields.validations]]
      name = "min"
      value = "5"
      [[extensions.settings.fields.validations]]
      name = "max"
      value = "20"
  ```