API version 2021-01 Release candidate
API version 2020-10 Latest
API version 2020-07
API version 2020-04
API version 2020-01
API version 2019-10 Unsupported
API version 2019-07 Unsupported

subscriptionDraftUpdate mutation

Version 2021-01 (Release candidate)

Updates a Subscription Draft.

Required access

write_own_subscription_contracts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


draftId ( ID! ) required

The gid of the Subscription Draft to update.

input ( SubscriptionDraftInput! ) required

The properties of the new Subscription Contract.

SubscriptionDraftInput fields

billingPolicy (SubscriptionBillingPolicyInput)

The billing policy for the subscription contract.

deliveryMethod (SubscriptionDeliveryMethodInput)

The delivery method for the subscription contract.

deliveryPolicy (SubscriptionDeliveryPolicyInput)

The delivery policy for the subscription contract.

deliveryPrice (Decimal)

The shipping price for each renewal the subscription contract.

paymentMethodId (ID)

The ID of the payment method to be used for the subscription contract.

status (SubscriptionContractSubscriptionStatus)

The current status of the subscription contract.

Return fields

draft (SubscriptionDraft)

The Subscription Draft object.

userErrors ([SubscriptionDraftUserError!]!)

List of errors that occurred executing the mutation.