# Extension
The API for interacting with the metadata of an extension.

## StandardApi
The base API object provided to `purchase`, and `customer-account.order-status` extension targets.
### Docs_Standard_ExtensionMetaApi

### extension
Meta information about the extension.
### Extension
Meta information about an extension target.
### apiVersion
The API version that was set in the extension config file.
### capabilities
The allowed capabilities of the extension, defined
in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.

* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.

* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.

* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
### editor
Information about the editor where the extension is being rendered.

The value is undefined if the extension is not rendering in an editor.
### rendered
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
The URL to the script that started the extension target.
### 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
The published version of the running extension target.

For unpublished extensions, the value is `undefined`.
### ApiVersion
Union of supported API versions
'2023-04' | '2023-07' | '2023-10' | 'unstable'
### Capability
The capabilities an extension has access to.

* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.

* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.

* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing'
### Editor

### type
Indicates whether the extension is rendering in the checkout editor.
## Related
- [Targets](/docs/api/checkout-ui-extensions/targets)
- [Components](/docs/api/checkout-ui-extensions/components)
- [Configuration](/docs/api/checkout-ui-extensions/configuration)
- [Tutorials](/apps/checkout)
## useExtension
Returns the metadata about the extension.
### UseExtensionGeneratedType
Returns the metadata about the extension.
#### Returns: Extension

export function useExtension(): Extension {
  return useApi().extension as Extension;
}
### Extension
Meta information about an extension target.
### apiVersion
The API version that was set in the extension config file.
### capabilities
The allowed capabilities of the extension, defined
in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.

* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.

* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.

* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
### editor
Information about the editor where the extension is being rendered.

The value is undefined if the extension is not rendering in an editor.
### rendered
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
The URL to the script that started the extension target.
### 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
The published version of the running extension target.

For unpublished extensions, the value is `undefined`.
### ApiVersion
Union of supported API versions
'2023-04' | '2023-07' | '2023-10' | 'unstable'
### Capability
The capabilities an extension has access to.

* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.

* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.

* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing'
### Editor

### type
Indicates whether the extension is rendering in the checkout editor.
## Related
- [Targets](/docs/api/checkout-ui-extensions/targets)
- [Components](/docs/api/checkout-ui-extensions/components)
- [Configuration](/docs/api/checkout-ui-extensions/configuration)
- [Tutorials](/apps/checkout)
## useExtensionData
Returns the metadata about the extension. This is deprecated, use `useExtension()` instead.
### UseExtensionDataGeneratedType
Returns the metadata about the extension.
> Caution: This is deprecated, use `useExtension()` instead.
#### Returns: Extension

export function useExtensionData(): Extension {
  return useExtension();
}
### Extension
Meta information about an extension target.
### apiVersion
The API version that was set in the extension config file.
### capabilities
The allowed capabilities of the extension, defined
in your [shopify.extension.toml](/docs/api/checkout-ui-extensions/configuration) file.

* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.

* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.

* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
### editor
Information about the editor where the extension is being rendered.

The value is undefined if the extension is not rendering in an editor.
### rendered
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
The URL to the script that started the extension target.
### 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
The published version of the running extension target.

For unpublished extensions, the value is `undefined`.
### ApiVersion
Union of supported API versions
'2023-04' | '2023-07' | '2023-10' | 'unstable'
### Capability
The capabilities an extension has access to.

* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.

* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.

* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing'
### Editor

### type
Indicates whether the extension is rendering in the checkout editor.
## Related
- [Targets](/docs/api/checkout-ui-extensions/targets)
- [Components](/docs/api/checkout-ui-extensions/components)
- [Configuration](/docs/api/checkout-ui-extensions/configuration)
- [Tutorials](/apps/checkout)
## useExtensionCapabilities
Returns a list of an extension's granted capabilities.
### UseExtensionCapabilitiesGeneratedType
Returns a list of an extension's granted capabilities.
#### Returns: Capability[]

export function useExtensionCapabilities(): Capability[] {
  return useSubscription(useApi().extension.capabilities);
}
### Capability
The capabilities an extension has access to.

* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.

* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.

* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing'
## Related
- [Targets](/docs/api/checkout-ui-extensions/targets)
- [Components](/docs/api/checkout-ui-extensions/components)
- [Configuration](/docs/api/checkout-ui-extensions/configuration)
- [Tutorials](/apps/checkout)
## useExtensionCapability
Returns whether or not a given capability of an extension is granted.
### UseExtensionCapabilityGeneratedType
Returns whether or not a given capability of an extension is granted.
#### Returns: boolean

#### Params:
- capability: Capability
export function useExtensionCapability(capability: Capability): boolean {
  return useExtensionCapabilities().includes(capability);
}
### Capability
The capabilities an extension has access to.

* [`api_access`](/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.

* [`network_access`](/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.

* [`block_progress`](/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a buyer's progress and the merchant has allowed this blocking behavior.

* [`collect_buyer_consent.sms_marketing`](/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect buyer consent for SMS marketing.
'api_access' | 'network_access' | 'block_progress' | 'collect_buyer_consent.sms_marketing'
## Related
- [Targets](/docs/api/checkout-ui-extensions/targets)
- [Components](/docs/api/checkout-ui-extensions/components)
- [Configuration](/docs/api/checkout-ui-extensions/configuration)
- [Tutorials](/apps/checkout)
## 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
Indicates whether the extension is rendering in the checkout editor.
## Related
- [Targets](/docs/api/checkout-ui-extensions/targets)
- [Components](/docs/api/checkout-ui-extensions/components)
- [Configuration](/docs/api/checkout-ui-extensions/configuration)
- [Tutorials](/apps/checkout)