---
title: Settings
description: The API for interacting with merchant settings.
api_version: 2024-07
api_name: checkout-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/checkout-ui-extensions/2024-07/apis/settings
  md: https://shopify.dev/docs/api/checkout-ui-extensions/2024-07/apis/settings.md
---

# SettingsAPI

The API for interacting with merchant settings.

## StandardApi

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

* settings

  StatefulRemoteSubscribable\<ExtensionSettings>

  required

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

  Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/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.

### ExtensionSettings

The merchant-defined setting values for the extension.



```ts
Record<
  string,
  string | number | boolean | undefined
>
```

## use​Settings()

Returns the setting values defined by the merchant for the extension.

### Returns

* Partial\<Settings extends ExtensionSettings>

### ExtensionSettings

The merchant-defined setting values for the extension.



```ts
Record<
  string,
  string | number | boolean | undefined
>
```

### Examples

* #### Accessing merchant settings

  ##### Description

  You can retrieve settings values within your extension. In React, the \`useSettings()\` hook re-renders your extension with the latest values. In JavaScript, subscribe to changes and update your UI directly.

  ##### React

  ```jsx
  import {
    reactExtension,
    Banner,
    useSettings,
  } from '@shopify/ui-extensions-react/checkout';

  export default reactExtension(
    'purchase.checkout.block.render',
    () => <Extension />,
  );

  function Extension() {
    const {banner_title} = useSettings();
    return <Banner title={banner_title} />;
  }
  ```

  ##### JavaScript

  ```js
  import {
    extension,
    Banner,
  } from '@shopify/ui-extensions/checkout';

  export default extension(
    'purchase.checkout.block.render',
    (root, {settings}) => {
      const banner = root.createComponent(Banner, {
        title: settings.current.banner_title,
      });

      // When the merchant updates the banner title in the checkout editor, re-render the banner
      settings.subscribe((newSettings) => {
        banner.updateProps({
          title: newSettings.banner_title,
        });
      });

      root.appendChild(banner);
    },
  );
  ```

## Examples

Define merchant settings

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

  ##### shopify.extension.toml

  ```toml
  api_version = "2023-07"

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

    [[extensions.targeting]]
    target = "purchase.checkout.block.render"
    module = "./Checkout.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"
  ```

## Related

[![](https://shopify.dev/images/icons/32/blocks.png)![](https://shopify.dev/images/icons/32/blocks-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/targets)

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

[![](https://shopify.dev/images/icons/32/apps.png)![](https://shopify.dev/images/icons/32/apps-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/components)

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

[![](https://shopify.dev/images/icons/32/gear.png)![](https://shopify.dev/images/icons/32/gear-dark.png)](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)

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

[![](https://shopify.dev/images/icons/32/tutorial.png)![](https://shopify.dev/images/icons/32/tutorial-dark.png)](https://shopify.dev/apps/checkout)

[LearnTutorials](https://shopify.dev/apps/checkout)