Skip to main content
Anchor to subscriptionContractUpdate

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 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?