AppSubscription - admin-graphql - OBJECT

Version: 2024-10

Description:

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

Access Scopes

Fields

• createdAt: DateTime! -

  The date and time when the app subscription was created.

• currentPeriodEnd: DateTime -

  The date and time when the current app subscription period ends. Returns null if the subscription isn't active.

• id: ID! -

  A globally-unique ID.

• lineItems: AppSubscriptionLineItem! -

  The plans attached to the app subscription.

• name: String! -

  The name of the app subscription.

• returnUrl: URL! -

  The URL that the merchant is redirected to after approving the app subscription.

• status: AppSubscriptionStatus! -

  The status of the app subscription.

• test: Boolean! -

  Specifies whether the app subscription is a test transaction.

• trialDays: Int! -

  The number of free trial days, starting at the subscription's creation date, by which billing is delayed.

Connections

Related queries

Related mutations

• appSubscriptionCancel

  Cancels an app subscription on a store.

• appSubscriptionCreate

  Allows an app to charge a store for features or services on a recurring basis.

• appSubscriptionLineItemUpdate

  Updates the capped amount on the usage pricing plan of an app subscription line item.

• appSubscriptionTrialExtend

  Extends the trial of an app subscription.

Related Unions

Examples