Choose a version:

subscriptionContractPause

mutation

Requires write_own_subscription_contracts access scope. Also: The user must have manage_orders_information permission.

Pauses a Subscription Contract.

Arguments

The actor who initiated a subscription action.

Show enum values

required

The ID of the Subscription Contract.

Was this section helpful?

Anchor to contractcontract •SubscriptionContract: The new Subscription Contract object.

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

subscriptionContractPause(actor: $actor, subscriptionContractId: $subscriptionContractId) {

contract {

# SubscriptionContract fields

}

userErrors {

field

message

}

{

"actor": "CUSTOMER",

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

}