# appSubscriptionCancel - admin-graphql - MUTATION Version: 2024-04 ## Description Cancels an app subscription on a store. ### Access Scopes ## Arguments * [id](/docs/api/admin-graphql/2024-04/scalars/ID): ID! - The ID of the app subscription to be cancelled. * [prorate](/docs/api/admin-graphql/2024-04/scalars/Boolean): Boolean - Whether to issue prorated credits for the unused portion of the app subscription. There will be a corresponding deduction (based on revenue share) to your Partner account. For example, if a $10.00 app subscription (with 0% revenue share) is cancelled and prorated half way through the billing cycle, then the merchant will be credited $5.00 and that amount will be deducted from your Partner account. ## Returns * [appSubscription](/docs/api/admin-graphql/2024-04/objects/AppSubscription): AppSubscription The cancelled app subscription. * [userErrors](/docs/api/admin-graphql/2024-04/objects/UserError): UserError! The list of errors that occurred from executing the mutation. ## Examples ### Cancel an app subscription on a shop and issue prorated credits Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) { appSubscriptionCancel(id: $id, prorate: $prorate) { userErrors { field message } appSubscription { id status } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/AppSubscription/1029266957\",\n \"prorate\": true\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {\n appSubscriptionCancel(id: $id, prorate: $prorate) {\n userErrors {\n field\n message\n }\n appSubscription {\n id\n status\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/AppSubscription/1029266957\",\n \"prorate\": true\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {\n appSubscriptionCancel(id: $id, prorate: $prorate) {\n userErrors {\n field\n message\n }\n appSubscription {\n id\n status\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/AppSubscription/1029266957\",\n \"prorate\": true\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {\n appSubscriptionCancel(id: $id, prorate: $prorate) {\n userErrors {\n field\n message\n }\n appSubscription {\n id\n status\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/AppSubscription/1029266957\",\n \"prorate\": true\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {\n appSubscriptionCancel(id: $id, prorate: $prorate) {\n userErrors {\n field\n message\n }\n appSubscription {\n id\n status\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/AppSubscription/1029266957", "prorate": true } #### Graphql Response { "data": { "appSubscriptionCancel": { "userErrors": [], "appSubscription": { "id": "gid://shopify/AppSubscription/1029266957", "status": "CANCELLED" } } } } ### Cancels a recurring application charge Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation AppSubscriptionCancel($id: ID!) { appSubscriptionCancel(id: $id) { userErrors { field message } appSubscription { id status } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/AppSubscription/1029266958\"\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation AppSubscriptionCancel($id: ID!) {\n appSubscriptionCancel(id: $id) {\n userErrors {\n field\n message\n }\n appSubscription {\n id\n status\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/AppSubscription/1029266958\"\n },\n },\n});\n" Ruby example: "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation AppSubscriptionCancel($id: ID!) {\n appSubscriptionCancel(id: $id) {\n userErrors {\n field\n message\n }\n appSubscription {\n id\n status\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/AppSubscription/1029266958\"\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation AppSubscriptionCancel($id: ID!) {\n appSubscriptionCancel(id: $id) {\n userErrors {\n field\n message\n }\n appSubscription {\n id\n status\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/AppSubscription/1029266958\"\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation AppSubscriptionCancel($id: ID!) {\n appSubscriptionCancel(id: $id) {\n userErrors {\n field\n message\n }\n appSubscription {\n id\n status\n }\n }\n}" #### Graphql Input { "id": "gid://shopify/AppSubscription/1029266958" } #### Graphql Response { "data": { "appSubscriptionCancel": { "userErrors": [], "appSubscription": { "id": "gid://shopify/AppSubscription/1029266958", "status": "CANCELLED" } } } }