subscriptionDraftFreeShippingDiscountUpdate mutation

Updates a subscription free shipping discount on a subscription draft.

Required access

write_own_subscription_contracts access scope.

On this page

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.

mutation subscriptionDraftFreeShippingDiscountUpdate($draftId: ID!, $discountId: ID!, $input: SubscriptionFreeShippingDiscountInput!) { subscriptionDraftFreeShippingDiscountUpdate(draftId: $draftId, discountId: $discountId, input: $input) { 
  1. <font style="color:#1F61A0;">discountUpdated</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">draft</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">code</font>
  17.   <font style="color:#1F61A0;">field</font>
  19.   <font style="color:#1F61A0;">message</font>
  21. <font style="color:#555555;">}</font>
} } { “draftId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “discountId”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “input”: {} }

Arguments

Argument Description
discountId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The gid of the Subscription Discount to update.
draftId
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the Subscription Contract draft to update a subscription discount on.
input
(
[SubscriptionFreeShippingDiscountInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionfreeshippingdiscountinput)

) REQUIRED		 The properties to update on the Subscription Free Shipping Discount.

SubscriptionFreeShippingDiscountInput fields

  • recurringCycleLimit ([Int](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01))
    The maximum number of times the subscription free shipping discount will be applied on orders.
  • title ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    The title associated with the subscription free shipping discount.

Return fields

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