Choose a version:

subscriptionContractPause

mutation

Requires the write_own_subscription_contracts scope.

Pauses a Subscription Contract.

Arguments

Anchor to subscriptionContractIdsubscriptionContractId •ID! required: The ID of the subscription contract to pause.

Was this section helpful?

Anchor to contractcontract •SubscriptionContract: The updated Subscription Contract after the pause operation.

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 subscriptionContractPause($subscriptionContractId: ID!) {

subscriptionContractPause(subscriptionContractId: $subscriptionContractId) {

contract {

# SubscriptionContract fields

}

userErrors {

field

message

}

{

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

}