appSubscriptionCreate mutation

Version 2020-01 (Release candidate)

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

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

lineItems ( [AppSubscriptionLineItemInput!]! ) required

Attaches a plan to an app subscription.

name ( String! ) required

The name of the app subscription.

returnUrl ( URL! ) required

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

test ( Boolean )

Specifies whether the app subscription is a test transaction. Default value is false.

trialDays ( Int )

The number of days of the free trial..

AppSubscriptionLineItemInput fields

plan (AppPlanInput!) Required

Defines the pricing model for the app subscription.

Return fields

appSubscription (AppSubscription)

The newly created app subscription.

confirmationUrl (URL)

The URL where the merchant approves or declines an app subscription.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Latest)

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

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

lineItems ( [AppSubscriptionLineItemInput!]! ) required

Attaches a plan to an app subscription.

name ( String! ) required

The name of the app subscription.

returnUrl ( URL! ) required

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

test ( Boolean )

Specifies whether the app subscription is a test transaction. Default value is false.

trialDays ( Int )

The number of days of the free trial..

AppSubscriptionLineItemInput fields

plan (AppPlanInput!) Required

Defines the pricing model for the app subscription.

Return fields

appSubscription (AppSubscription)

The newly created app subscription.

confirmationUrl (URL)

The URL where the merchant approves or declines an app subscription.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07

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

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

lineItems ( [AppSubscriptionLineItemInput!]! ) required

Attaches a plan to an app subscription.

name ( String! ) required

The name of the app subscription.

returnUrl ( URL! ) required

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

test ( Boolean )

Specifies whether the app subscription is a test transaction. Default value is false.

trialDays ( Int )

The number of days of the free trial..

AppSubscriptionLineItemInput fields

plan (AppPlanInput!) Required

Defines the pricing model for the app subscription.

Return fields

appSubscription (AppSubscription)

The newly created app subscription.

confirmationUrl (URL)

The URL where the merchant approves or declines an app subscription.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Sign up for a Partner account to get started.

Sign up