appSubscriptionCreate mutation

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

On this page

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.

mutation appSubscriptionCreate($name: String!, $lineItems: [AppSubscriptionLineItemInput!]!, $returnUrl: URL!) { appSubscriptionCreate(name: $name, lineItems: $lineItems, returnUrl: $returnUrl) { 
  1. <font style="color:#1F61A0;">appSubscription</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">confirmationUrl</font>
  9. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <font style="color:#555555;">}</font>
} } { “name”: “placeholder”, “lineItems”: [ 
  1. <font style="color:#555555;">{</font>
  3.   <font style="color:#8B2BB9;">"plan"</font><font style="color:#555555;">:</font> <font style="color:#555555;">{}</font>
  5. <font style="color:#555555;">}</font>
], “returnUrl”: “placeholder” }

Arguments

Argument Description
lineItems
(
[[AppSubscriptionLineItemInput!]!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscriptionlineiteminput)

) REQUIRED		 Attaches a plan to an app subscription.
name
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The name of the app subscription.
returnUrl
(
[URL!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01)

) REQUIRED		 The URL where the merchant is redirected after approving the app subscription.
test
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Specifies whether the app subscription is a test transaction. Default value is false.
trialDays
(
[Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

)		 The number of days of the free trial..

AppSubscriptionLineItemInput fields

  • plan ([AppPlanInput!](https://shopify.dev/docs/admin-api/graphql/reference/billing/appplaninput)) REQUIRED
    Defines the pricing model for the app subscription.

Return fields

  • appSubscription ([AppSubscription](https://shopify.dev/docs/admin-api/graphql/reference/billing/appsubscription))
    The newly created app subscription.
  • confirmationUrl ([URL](https://shopify.dev/docs/admin-api/graphql/reference/scalar#url-2021-01))
    The URL where the merchant approves or declines an app subscription.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.