subscriptionContractUpdate
mutation

Choose a version:

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?

Code examples for MUTATION: subscriptionContractUpdate

Query Reference for MUTATION: subscriptionContractUpdate

"mutation subscriptionContractUpdate($contractId: ID!) {\n  subscriptionContractUpdate(contractId: $contractId) {\n    draft {\n      # SubscriptionDraft fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionContractUpdate

"{\n  \"contractId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: subscriptionContractUpdate

""

Display Examples for MUTATION: subscriptionContractUpdate

[]

subscriptionContractUpdatemutation

Arguments

SubscriptionContractUpdatePayload returns

subscriptionContractUpdate
mutation