# Extension The API for interacting with the metadata of an extension. ## StandardApi The base API object provided to this and other `customer-account` extension targets. ### Docs_Standard_ExtensionApi ### extension value: `Extension` - Extension: export interface Extension { /** * The API version that was set in the extension config file. * * @example '2023-04', '2023-07' */ apiVersion: ApiVersion; /** * The allowed capabilities of the extension, defined * in your [shopify.ui.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file. * * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API. * * * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls. * * * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior. */ capabilities: StatefulRemoteSubscribable; /** * Information about the editor where the extension is being rendered. * * The value is undefined if the extension is not rendering in an editor. */ editor?: Editor; /** * Whether your extension is currently rendered to the screen. * * Shopify might render your extension before it's visible in the UI, * typically to pre-render extensions that will appear on a later step of the * checkout. * * Your extension might also continue to run after the buyer has navigated away * from where it was rendered. The extension continues running so that * your extension is immediately available to render if the buyer navigates back. */ rendered: StatefulRemoteSubscribable; /** * The URL to the script that started the extension target. */ scriptUrl: string; /** * The identifier that specifies where in Shopify’s UI your code is being * injected. This will be one of the targets you have included in your * extension’s configuration file. * * @example 'customer-account.order-status.block.render' * @see /docs/api/checkout-ui-extensions/unstable/extension-targets-overview * @see /docs/apps/app-extensions/configuration#targets */ target: Target; /** * The published version of the running extension target. * * For unpublished extensions, the value is `undefined`. * * @example 3.0.10 */ version?: string; } Meta information about the extension. ### Extension Meta information about an extension target. ### apiVersion value: `ApiVersion` - ApiVersion: '2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | 'unstable' The API version that was set in the extension config file. ### capabilities value: `StatefulRemoteSubscribable` - Capability: 'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources' The allowed capabilities of the extension, defined in your [shopify.ui.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file. * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API. * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls. * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior. ### editor value: `Editor` - Editor: export interface Editor { /** * Indicates whether the extension is rendering in the checkout editor. */ type: 'checkout'; } Information about the editor where the extension is being rendered. The value is undefined if the extension is not rendering in an editor. ### rendered value: `StatefulRemoteSubscribable` Whether your extension is currently rendered to the screen. Shopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout. Your extension might also continue to run after the buyer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the buyer navigates back. ### scriptUrl value: `string` The URL to the script that started the extension target. ### target value: `Target` The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file. ### version value: `string` The published version of the running extension target. For unpublished extensions, the value is `undefined`. ### Editor ### type value: `"checkout"` Indicates whether the extension is rendering in the checkout editor. ## useExtension Returns the metadata of the extension. ### UseExtensionGeneratedType Returns the metadata of the extension. #### Returns: Extension export function useExtension(): Extension { return useApi().extension; } ### Extension Meta information about an extension target. ### apiVersion value: `ApiVersion` - ApiVersion: '2023-04' | '2023-07' | '2023-10' | '2024-01' | '2024-04' | '2024-07' | '2024-10' | 'unstable' The API version that was set in the extension config file. ### capabilities value: `StatefulRemoteSubscribable` - Capability: 'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing' | 'collect_buyer_consent.customer_privacy' | 'iframe.sources' The allowed capabilities of the extension, defined in your [shopify.ui.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file. * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API. * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls. * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior. ### editor value: `Editor` - Editor: export interface Editor { /** * Indicates whether the extension is rendering in the checkout editor. */ type: 'checkout'; } Information about the editor where the extension is being rendered. The value is undefined if the extension is not rendering in an editor. ### rendered value: `StatefulRemoteSubscribable` Whether your extension is currently rendered to the screen. Shopify might render your extension before it's visible in the UI, typically to pre-render extensions that will appear on a later step of the checkout. Your extension might also continue to run after the buyer has navigated away from where it was rendered. The extension continues running so that your extension is immediately available to render if the buyer navigates back. ### scriptUrl value: `string` The URL to the script that started the extension target. ### target value: `Target` The identifier that specifies where in Shopify’s UI your code is being injected. This will be one of the targets you have included in your extension’s configuration file. ### version value: `string` The published version of the running extension target. For unpublished extensions, the value is `undefined`. ### Editor ### type value: `"checkout"` Indicates whether the extension is rendering in the checkout editor. ## useExtensionEditor Returns information about the editor where the extension is being rendered. ### UseExtensionEditorGeneratedType Returns information about the editor where the extension is being rendered. #### Returns: Editor | undefined export function useExtensionEditor(): Editor | undefined { return useApi().extension.editor; } ### Editor ### type value: `"checkout"` Indicates whether the extension is rendering in the checkout editor.