Skip to main content
Anchor to AppSubscriptionCancelPayload

AppSubscriptionCancelPayload

payload

The result of an appSubscriptionCancel mutation.

•CancelledSubscription

The app subscription that was cancelled.

•[UserError!]

Errors when cancelling the app subscription.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Cancels an app subscription.

Arguments

•ID!
required

The id of the app. Example value: gid://shopify/App/123.

•Boolean!
required

Whether to defer cancellation until the end of the current billing cycle.

•Boolean!
required

Whether to issue prorated credits for the unused portion of the subscription. Cannot be used together with skipFinalUsageCharge.

•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?