Skip to main content
Anchor to AppInstallation

AppInstallation

object

Represents an installed application on a shop.

Anchor to FieldsFields

Anchor to accessScopesaccessScopes
•[AccessScope!]!
non-null

The access scopes granted to the application by a merchant during installation.

Anchor to activeSubscriptionsactiveSubscriptions
•[AppSubscription!]!
non-null

The active application subscriptions billed to the shop on a recurring basis.

Anchor to allSubscriptionsallSubscriptions
•AppSubscriptionConnection!
non-null

All subscriptions created for a shop.

Anchor to appapp
•App!
non-null

Application which is installed.

Anchor to creditscredits
•AppCreditConnection!
non-null

Credits that can be used towards future app purchases.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to launchUrllaunchUrl
•URL!
non-null

The URL to launch the application.

Anchor to metafieldmetafield
•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Anchor to oneTimePurchasesoneTimePurchases
•AppPurchaseOneTimeConnection!
non-null

One-time purchases to a shop.

Anchor to publicationpublication
•Publication

The publication associated with the installed application.

Anchor to revenueAttributionRecordsrevenueAttributionRecords
•AppRevenueAttributionRecordConnection!
non-null

The records that track the externally-captured revenue for the app. The records are used for revenue attribution purposes.

Anchor to uninstallUrluninstallUrl
•URL

The URL to uninstall the application.

Deprecated fields

Anchor to channelchannel
•Channel
Deprecated
Anchor to subscriptionssubscriptions
•[AppSubscription!]!
non-nullDeprecated
Was this section helpful?

Anchor to QueriesQueries

Anchor to appInstallationappInstallation
•query

Look up an app installation by ID or return the app installation for the currently authenticated app.

Use the appInstallation query to:

  • Fetch current access scope permissions for your app
  • Retrieve active subscription details and billing status
  • Validate installation state during app initialization
  • Display installation-specific information in your app interface

Learn more about app installation.

Anchor to appInstallationsappInstallations
•query

A list of app installations. To use this query, your app needs the read_apps access scope, which can only be requested after you're granted approval from Shopify Support. This scope can be granted to custom and public apps.

Returns a paginated connection of AppInstallation objects across multiple stores.

Learn more about app installation.

Anchor to currentAppInstallationcurrentAppInstallation
•query

Return the AppInstallation for the currently authenticated App.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?