API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

AppSubscription object

Version unstable

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 unstable

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

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.

Version unstable

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

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.

Version 2021-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 2021-01 (Release candidate)

On this page

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2021-01 (Release candidate)

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

Version 2020-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 2020-10 (Latest)

On this page

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-10 (Latest)

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

Version 2020-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

Version 2020-07

On this page

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-07

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

Version 2020-04

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 2020-04

On this page

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-04

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

Version 2020-01

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 2020-01

On this page

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2020-01

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

Version 2019-10 (Unsupported)

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 (Unsupported)

On this page

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-10 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

Version 2019-07 (Unsupported)

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 (Unsupported)

On this page

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-07 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

Version 2019-04 (Unsupported)

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-04 (Unsupported)

On this page

Fields

edges ([AppSubscriptionEdge!]!)

A list of edges.

pageInfo (PageInfo!)

Information to aid in pagination.

Version 2019-04 (Unsupported)

Fields

cursor (String!)

A cursor for use in pagination.

node (AppSubscription!)

The item at the end of AppSubscriptionEdge.

Types that return AppSubscriptionEdge

Samples