AppInstallation object

Represents an installed application on a shop.

On this page

Connections

allSubscriptions ([AppSubscriptionConnection!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscription))
All subscriptions created for a shop.

Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
sortKey
(
[AppSubscriptionSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscriptionsortkeys)

)		 Sort the underlying list by the given key.
Default value: CREATED_AT

credits ([AppCreditConnection!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appcredit))
Credits that can be used towards future app purchases.

Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
sortKey
(
[AppTransactionSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/billing/apptransactionsortkeys)

)		 Sort the underlying list by the given key.
Default value: CREATED_AT

oneTimePurchases ([AppPurchaseOneTimeConnection!](https://shopify.dev/docs/admin-api/graphql/reference/billing/apppurchaseonetime))
One-time purchases to a shop.

Argument Description
after
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come after the specified cursor.
before
(
[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

)		 Returns the elements that come before the specified cursor.
first
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the first n elements from the list.
last
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 Returns up to the last n elements from the list.
reverse
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Reverse the order of the underlying list.
Default value: false
sortKey
(
[AppTransactionSortKeys](https://shopify.dev/docs/admin-api/graphql/reference/billing/apptransactionsortkeys)

)		 Sort the underlying list by the given key.
Default value: CREATED_AT

Fields

  • accessScopes ([[AccessScope!]!](https://shopify.dev/docs/admin-api/graphql/reference/access/accessscope))
    Access scopes granted to an app by a merchant during installation.
  • activeSubscriptions ([[AppSubscription!]!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscription))
    Active subscriptions charged to a shop on a recurring basis.
  • app ([App!](https://shopify.dev/docs/admin-api/graphql/reference/apps/app))
    Application which is installed.
  • id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
    Globally unique identifier.
  • launchUrl ([URL!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    Url used to launch the app.
  • publication ([Publication](https://shopify.dev/docs/admin-api/graphql/reference/apps/publication))
    Publication associated with the installed application.
  • uninstallUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    Webpage where you can uninstall the app.

Types that return AppInstallation

  • [App.installation](https://shopify.dev/docs/admin-api/graphql/reference/apps/app#installation-2021-01)
  • [QueryRoot.appInstallation](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#appinstallation-2021-01)
  • [QueryRoot.appInstallations](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#appinstallations-2021-01)
  • [QueryRoot.currentAppInstallation](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#currentappinstallation-2021-01)

Implements

  • [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

  • channel ([Channel](https://shopify.dev/docs/admin-api/graphql/reference/products-and-collections/channel)) DEPRECATED
    Channel associated with the installed application.
    Deprecation warning
    Use publication instead
  • subscriptions ([[AppSubscription!]!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscription)) DEPRECATED
    Subscriptions charge to a shop on a recurring basis.
    Deprecation warning
    Use activeSubscriptions instead