Anchor to section titled 'undefined'

subscriptionContractUpdate
mutation

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

The subscriptionContractUpdate mutation allows you to create a draft of an existing subscription contract. This draft can be reviewed and modified as needed. Once the draft is committed with subscriptionDraftCommit, the changes are applied to the original subscription contract.

Anchor to section titled 'Arguments'

Arguments

Anchor to contractId
contractId
ID!
required

The gid of the Subscription Contract to update.

Was this section helpful?
Anchor to section titled 'SubscriptionContractUpdatePayload returns'

SubscriptionContractUpdatePayload returns

Anchor to SubscriptionContractUpdatePayload.draft
draft
SubscriptionDraft

The Subscription Contract object.

Anchor to SubscriptionContractUpdatePayload.userErrors
userErrors
[SubscriptionDraftUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation subscriptionContractUpdate($contractId: ID!) {
  subscriptionContractUpdate(contractId: $contractId) {
    draft {
      # SubscriptionDraft fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "contractId": "gid://shopify/<objectName>/10079785100"
}