subscriptionContractFail

mutation

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

Fails a Subscription Contract.

Arguments

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

Was this section helpful?

Anchor to SubscriptionContractFailPayload returnsSubscriptionContractFailPayload returns

Anchor to contractcontract • SubscriptionContract: The new Subscription Contract object.
Anchor to userErrorsuserErrors • [SubscriptionContractStatusUpdateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation subscriptionContractFail($subscriptionContractId: ID!) {
2  subscriptionContractFail(subscriptionContractId: $subscriptionContractId) {
3    contract {
4      # SubscriptionContract fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "subscriptionContractId": "gid://shopify/<objectName>/10079785100"
3}

{
  "subscriptionContractId": "gid://shopify/<objectName>/10079785100"
}