Choose a version:

subscriptionContractUpdate

mutation

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

Deprecated.

Use subscriptionContractUpdateCalculate instead.

Creates a draft of an existing SubscriptionContract. The draft captures the current state of the contract and allows incremental modifications through draft mutations such as subscriptionDraftLineAdd, subscriptionDraftDiscountAdd, and subscriptionDraftUpdate.

Changes remain in draft state and don't affect the live contract until committed. After you've made all necessary changes to the draft, commit it using subscriptionDraftCommit to apply the updates to the original contract.

This mutation and the draft-based edit flow are deprecated in favor of the SubscriptionContractCalculation API.

Learn more about updating subscription contracts.

Anchor to Arguments

Arguments

Anchor to contractIdcontractId •ID! required: The gid of the Subscription Contract to update.

Was this section helpful?

Anchor to SubscriptionContractUpdatePayload returnsSubscriptionContractUpdatePayload returns

Anchor to draftdraft •SubscriptionDraft: The Subscription Contract object.
Anchor to userErrorsuserErrors •[SubscriptionDraftUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

subscriptionContractUpdate reference

Mutation Reference

mutation subscriptionContractUpdate($contractId: ID!) {

subscriptionContractUpdate(contractId: $contractId) {

draft {

# SubscriptionDraft fields

}

userErrors {

field

message

}

Input

{

"contractId": "gid://shopify/SubscriptionContract/10079785100"

}