AppSubscription object

Version 2020-01 (Release candidate)

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

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.

id (ID!)

Globally unique identifier.

lineItems ([AppSubscriptionLineItem!]!)

Attaches a plan to an app subscription.

name (String!)

The name of the app subscription.

returnUrl (URL!)

The URL where the merchant is redirected after approving the app subscription.

status (AppSubscriptionStatus!)

The status of the app subscription. Possible values include pending, active, declined, expired, frozen, and cancelled.

test (Boolean!)

Specifies whether the app subscription is a test transaction.

trialDays (Int!)

The number of days of the free trial.

Types that return AppSubscription

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

Version 2019-10 (Latest)

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

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.

id (ID!)

Globally unique identifier.

lineItems ([AppSubscriptionLineItem!]!)

Attaches a plan to an app subscription.

name (String!)

The name of the app subscription.

returnUrl (URL!)

The URL where the merchant is redirected after approving the app subscription.

status (AppSubscriptionStatus!)

The status of the app subscription. Possible values include pending, active, declined, expired, frozen, and cancelled.

test (Boolean!)

Specifies whether the app subscription is a test transaction.

trialDays (Int!)

The number of days of the free trial.

Types that return AppSubscription

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

Version 2019-07

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

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.

id (ID!)

Globally unique identifier.

lineItems ([AppSubscriptionLineItem!]!)

Attaches a plan to an app subscription.

name (String!)

The name of the app subscription.

returnUrl (URL!)

The URL where the merchant is redirected after approving the app subscription.

status (AppSubscriptionStatus!)

The status of the app subscription. Possible values include pending, active, declined, expired, frozen, and cancelled.

test (Boolean!)

Specifies whether the app subscription is a test transaction.

trialDays (Int!)

The number of days of the free trial.

Types that return AppSubscription

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

Sign up for a Partner account to get started.

Sign up