Customer account UI extensions

Customer account UI extensions let app developers build custom functionality that merchants can install at defined points on the Order index, Order status, and Profile pages in customer accounts.

Shopify Plus

Some static extensions on the Profile page only render for B2B customers. B2B on Shopify is only available on the Shopify Plus plan. See B2B Profile targets

Choose a version:

Anchor to scaffolding-extensionScaffolding an extension

Use the Shopify CLI to generate a new extension in the directory of your app.

Make sure you’re using Shopify CLI v3.85.3 or higher. You can check your version by running shopify version.

Shopify CLI

# create an app if you don't already have one:

shopify app init --name my-app

# navigate to your app's root directory:

cd my-app

# generate a new extension:

shopify app generate extension

# follow the steps to create a new

# extension in ./extensions.

Examples

Shopify CLI

Default

# create an app if you don't already have one:
shopify app init --name my-app

# navigate to your app's root directory:
cd my-app

# generate a new extension:
shopify app generate extension

# follow the steps to create a new
# extension in ./extensions.

Anchor to configuration-fileConfiguration file

When you create a customer account UI extension, the shopify.extension.toml file is automatically generated in your extension directory. Use this file to configure your extension name, extension targets, metafields, capabilities, and settings definition.

Extension targets provide locations where merchants can insert custom content. Static extension targets render immediately before or after most core customer account features. Block extension targets render between core customer account features. Block extensions are always rendered, regardless of what other elements of the customer account are present.

Navigate toConfiguration guide

OverviewExtension targets

Shopify.extension.toml

api_version = "2025-10"

[[extensions]]

name = "Your customer account ui extension"

handle = "customer-account-ui"

type = "ui_extension"

uid = "4be0643f-1d98-e73b-17cd-ca98a65347dda7632660"

[[extensions.targeting]]

target = "customer-account.order-status.block.render"

module = "./Extension.jsx"

Examples

shopify.extension.toml

Default

api_version = "2025-10"

[[extensions]]
name = "Your customer account ui extension"
handle = "customer-account-ui"
type = "ui_extension"
uid = "4be0643f-1d98-e73b-17cd-ca98a65347dda7632660"

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

Anchor to extension-functionsExtension functions

Customer account will execute the module’s default export so it can render a user interface.

Extension UIs are powered by Remote DOM, a fast and secure environment for custom (non-DOM) UIs.

Extension.jsx

import '@shopify/ui-extensions/preact';

import {render} from 'preact';

export default async () => {

render(<Extension />, document.body);

};

function Extension() {

return <s-banner>Your extension</s-banner>;

}

Examples

Extension.jsx

Default

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

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

function Extension() {
  return <s-banner>Your extension</s-banner>;
}

Anchor to preact-by-defaultPreact by default

UI Extensions are scaffolded with Preact by default. This means you can use Preact patterns and principles within your extension.

Since Preact is included as a standard dependency, you have access to all of its features including hooks like useState and useEffect for managing component state and side effects.

You can also use Preact Signals for reactive state management, and take advantage of standard web APIs just like you would in a regular Preact application.

Extension.jsx

import '@shopify/ui-extensions/preact';

import {render} from 'preact';

import {useState} from 'preact/hooks';

export default async () => {

render(<Extension />, document.body);

};

function Extension() {

const [count, setCount] = useState(0);

return (

<s-text>Count: {count}</s-text>

<s-button

onClick={() => setCount(count + 1)}

Increment

</s-button>

</>

);

}

Examples

Extension.jsx

Default

import '@shopify/ui-extensions/preact';
import {render} from 'preact';
import {useState} from 'preact/hooks';

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

function Extension() {
  const [count, setCount] = useState(0);

  return (
    <>
      <s-text>Count: {count}</s-text>
      <s-button
        onClick={() => setCount(count + 1)}
      >
        Increment
      </s-button>
    </>
  );
}

Anchor to extension-apisExtension APIs

The platform defines a global shopify object that contains all properties and methods available to UI extensions.

These APIs enable UI extensions to get information about the customer account or related objects and to perform actions. For example, you can retrieve what’s in an order and offer related products.

APIs with a value property are Preact Signals. Preact will automatically re-render your extension as values change.

Navigate toCustomer account UI extensions APIs

Extension.jsx

Preact

import '@shopify/ui-extensions/preact';

import {render} from 'preact';

export default async () => {

render(<Extension />, document.body);

};

function Extension() {

return (

<s-banner>

{shopify.i18n.translate('welcomeMessage')}

</s-banner>

);

}

Examples

Extension.jsx

Preact

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

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

function Extension() {
  return (
    <s-banner>
      {shopify.i18n.translate('welcomeMessage')}
    </s-banner>
  );
}

Anchor to ui-componentsUI components

Customer account UI extensions declare their interface using Polaris web components. Shopify renders the UI natively, so it’s performant, accessible, and works in all of customer account’s supported browsers.

Customer account components are designed to be flexible, enabling you to layer and mix them to create highly-customized app extensions that feel seamless within the customer account experience. All components inherit a merchant’s brand settings and the CSS cannot be altered or overridden.

API ReferenceComponent library

UI ReferenceFigma UI kit

Extension.jsx

import '@shopify/ui-extensions/preact';

import {render} from 'preact';

export default async () => {

render(<Extension />, document.body);

};

function Extension() {

return (

<s-stack direction="block">

<s-image src="https://cdn.shopify.com/YOUR_IMAGE_HERE" />

<s-stack>

<s-heading>Heading</s-heading>

<s-text type="small">Description</s-text>

</s-stack>

<s-button

onClick={() => {

console.log('button was pressed');

}}

Button

</s-button>

</s-stack>

);

}

Examples

Extension.jsx

Default

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

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

function Extension() {
  return (
    <s-stack direction="block">
      <s-image src="https://cdn.shopify.com/YOUR_IMAGE_HERE" />
      <s-stack>
        <s-heading>Heading</s-heading>
        <s-text type="small">Description</s-text>
      </s-stack>
      <s-button
        onClick={() => {
          console.log('button was pressed');
        }}
      >
        Button
      </s-button>
    </s-stack>
  );
}

An animation of a card that contains an image, heading, description, and button, shifting and transforming into highly customized versions of the same UI to reflect each merchant's unique branding.

Anchor to custom-protocolsCustom protocols

Custom protocols make it easier to navigate to common locations, and construct URLs.

Anchor to custom-protocols-shopify-protocolShopify protocol

Use the shopify:customer-account protocol when you want to construct a URL with a root of customer accounts.

Anchor to custom-protocols-relative-urlsRelative URLs

Relative URLs are relative to your extension and are useful when you want to link to a route in your extension.

Anchor to custom-protocols-extension-protocolExtension Protocol

Triggers a navigation to an extension using the extension: protocol. The handle is the handle of the extension that will be navigated to in the same application. Build a full-page extension to create a new page in customer accounts and handle the navigation.

Shopify:customer-account

Link to Order Index page

<s-link

href="shopify:customer-account/orders"

></s-link>

Anchor to securitySecurity

Customer account UI extensions are a safe and secure way to customize the appearance and functionality of the customer account pages without compromising the security of customer data.

They run in an isolated sandbox, separate from the customer account page and other UI extensions.
They don't have access to sensitive payment information or the customer account page itself (HTML or other assets).
They are limited to specific UI components and APIs that are exposed by the platform.
They have limited access to global web APIs.
Apps that wish to access protected customer data, must submit an application and are subject to strict security guidelines and review proccesses by Shopify.

Constraints

You can’t override the CSS for UI components. The customer account UI will always render the merchant’s own branding.

Customer account UI extensions don’t have access to the real customer account DOM and can’t render arbitrary HTML such as <div> elements or <script> tags, etc. They can only render custom HTML elements provided by Shopify.