AppSubscription object

Provides users access to services and/or features for a duration of time.

On this page

• Fields
• Types that return AppSubscription
• Mutations for AppSubscription
• Implements
• Samples

Fields

• createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The date and time when the app subscription was created.
• currentPeriodEnd ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The date and time when the current app subscription period ends.
• id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Globally unique identifier.
• lineItems ([[AppSubscriptionLineItem!]!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscriptionlineitem))
  Attaches a plan to an app subscription.
• name ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The name of the app subscription.
• returnUrl ([URL!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
  The URL where the merchant is redirected after approving the app subscription.
• status ([AppSubscriptionStatus!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscriptionstatus))
  The status of the app subscription. Possible values include pending, active, declined, expired, frozen, and cancelled.
• test ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Specifies whether the app subscription is a test transaction.
• trialDays ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
  The number of days of the free trial.

Types that return AppSubscription

• [AppInstallation.activeSubscriptions](https://shopify.dev/docs/admin-api/graphql/reference/apps/appinstallation#activesubscriptions-2021-01)
• [AppInstallation.allSubscriptions](https://shopify.dev/docs/admin-api/graphql/reference/apps/appinstallation#allsubscriptions-2021-01)

Mutations for AppSubscription

• appSubscriptionCancel
  Cancels an app subscription on a store.
• appSubscriptionCreate
  Allows an app to charge a store for features or services on a recurring basis.

Implements

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

An auto-generated type for paginating through multiple AppSubscriptions.

On this page

• Fields

Fields

• edges ([[AppSubscriptionEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscription))
  A list of edges.
• pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
  Information to aid in pagination.

An auto-generated type which holds one AppSubscription and a cursor during pagination.

On this page

• Fields
• Types that return AppSubscriptionEdge

Fields

• cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A cursor for use in pagination.
• node ([AppSubscription!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscription))
  The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

• [AppSubscriptionConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscription#edges-2021-01)