subscriptionDraftUpdate mutation

Updates a Subscription Draft.

Required access

write_own_subscription_contracts access scope.

On this page

• Interactive example
• Arguments
• SubscriptionDraftInput fields
• Return fields

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.

<font style="color:#1F61A0;">draft</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">code</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

Arguments

SubscriptionDraftInput fields

• billingPolicy ([SubscriptionBillingPolicyInput](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingpolicyinput))
  The billing policy for the subscription contract.
• deliveryMethod ([SubscriptionDeliveryMethodInput](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondeliverymethodinput))
  The delivery method for the subscription contract.
• deliveryPolicy ([SubscriptionDeliveryPolicyInput](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondeliverypolicyinput))
  The delivery policy for the subscription contract.
• deliveryPrice ([Decimal](https://shopify.dev/docs/admin-api/graphql/reference/scalar#decimal-2021-01))
  The shipping price for each renewal the subscription contract.
• nextBillingDate ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The next billing date for the subscription contract.
• paymentMethodId ([ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  The ID of the payment method to be used for the subscription contract.
• status ([SubscriptionContractSubscriptionStatus](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontractsubscriptionstatus))
  The current status of the subscription contract.

Return fields

• draft ([SubscriptionDraft](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondraft))
  The Subscription Draft object.
• userErrors ([[SubscriptionDraftUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptiondraftusererror))
  List of errors that occurred executing the mutation.