Skip to main content
Anchor to SubscriptionContractUpdatePayload

SubscriptionContractUpdatePayload

payload

Return type for subscriptionContractUpdate mutation.

Anchor to FieldsFields

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?

Anchor to Mutations with this payloadMutations with this payload

Anchor to subscriptionContractUpdatesubscriptionContractUpdate
•mutation

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.

Learn more about updating subscription contracts.

Arguments

Anchor to contractIdcontractId
•ID!
required

The gid of the Subscription Contract to update.

Was this section helpful?