Choose a version:

subscriptionContractCancel

mutation

Requires the write_own_subscription_contracts scope.

Cancels a Subscription Contract.

Arguments

Anchor to subscriptionContractIdsubscriptionContractId •ID! required: The ID of the Subscription Contract to cancel.

Was this section helpful?

Anchor to contractcontract •SubscriptionContract: The canceled Subscription Contract.

Show fields
Anchor to userErrorsuserErrors •[SubscriptionContractStatusUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

mutation subscriptionContractCancel($subscriptionContractId: ID!) {

subscriptionContractCancel(subscriptionContractId: $subscriptionContractId) {

contract {

# SubscriptionContract fields

}

userErrors {

field

message

}

{

"subscriptionContractId": "gid://shopify/SubscriptionContract/10079785100"

}