Choose a version:

appSubscriptionCancel

mutation

Cancels an app subscription.

Anchor to Arguments

Arguments

Anchor to appIdappId •ID! required: The id of the app. Example value: gid://shopify/App/123.
Anchor to deferCancellationdeferCancellation •Boolean! required: Whether to defer cancellation until the end of the current billing cycle.
Anchor to prorateprorate •Boolean! required: Whether to issue prorated credits for the unused portion of the subscription. Cannot be used together with skipFinalUsageCharge.
Anchor to shopIdshopId •ID! required: The id of the shop. Example value: gid://shopify/Shop/456.
Anchor to skipFinalUsageChargeskipFinalUsageCharge •Boolean! required: Whether to skip the final usage charge when cancelling. Only applicable to usage-billed subscriptions. Cannot be used together with prorate.

Was this section helpful?

Anchor to AppSubscriptionCancelPayload returnsAppSubscriptionCancelPayload returns

Anchor to appSubscriptionappSubscription •CancelledSubscription: The app subscription that was cancelled.
Anchor to userErrorsuserErrors •[UserError!]: Errors when cancelling the app subscription.

Was this section helpful?

Examples

appSubscriptionCancel reference

Mutation Reference

mutation appSubscriptionCancel($appId: ID!, $deferCancellation: Boolean!, $prorate: Boolean!, $shopId: ID!, $skipFinalUsageCharge: Boolean!) {

appSubscriptionCancel(appId: $appId, deferCancellation: $deferCancellation, prorate: $prorate, shopId: $shopId, skipFinalUsageCharge: $skipFinalUsageCharge) {

appSubscription {

# CancelledSubscription fields

}

userErrors {

field

message

}

Input

{

"appId": "gid://shopify/<objectName>/10079785100",

"deferCancellation": true,

"prorate": true,

"shopId": "gid://shopify/<objectName>/10079785100",

"skipFinalUsageCharge": true

}