appSubscriptionCancel

mutation

Cancels an app subscription on a store.

Arguments

Anchor to idid • ID!required: The ID of the app subscription to be cancelled.
Anchor to prorateprorate • BooleanDefault:false: 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.

Was this section helpful?

Anchor to AppSubscriptionCancelPayload returnsAppSubscriptionCancelPayload returns

Anchor to appSubscriptionappSubscription • AppSubscription: The cancelled app subscription.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {
6    appSubscriptionCancel(id: $id, prorate: $prorate) {
7      userErrors {
8        field
9        message
10      }
11      appSubscription {
12        id
13        status
14      }
15    }
16  }`,
17  {
18    variables: {
19      "id": "gid://shopify/AppSubscription/1029266957",
20      "prorate": true
21    },
22  },
23);
24
25const data = await response.json();
26

mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {
  appSubscriptionCancel(id: $id, prorate: $prorate) {
    userErrors {
      field
      message
    }
    appSubscription {
      id
      status
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) { appSubscriptionCancel(id: $id, prorate: $prorate) { userErrors { field message } appSubscription { id status } } }",
 "variables": {
    "id": "gid://shopify/AppSubscription/1029266957",
    "prorate": true
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {
    appSubscriptionCancel(id: $id, prorate: $prorate) {
      userErrors {
        field
        message
      }
      appSubscription {
        id
        status
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/AppSubscription/1029266957",
      "prorate": true
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {
      appSubscriptionCancel(id: $id, prorate: $prorate) {
        userErrors {
          field
          message
        }
        appSubscription {
          id
          status
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/AppSubscription/1029266957",
      "prorate": true
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation AppSubscriptionCancel($id: ID!, $prorate: Boolean) {
    appSubscriptionCancel(id: $id, prorate: $prorate) {
      userErrors {
        field
        message
      }
      appSubscription {
        id
        status
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/AppSubscription/1029266957",
  "prorate": true
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "id": "gid://shopify/AppSubscription/1029266957",
3  "prorate": true
4}

Response

JSON

1{
2  "appSubscriptionCancel": {
3    "userErrors": [],
4    "appSubscription": {
5      "id": "gid://shopify/AppSubscription/1029266957",
6      "status": "CANCELLED"
7    }
8  }
9}