subscriptionDraftDiscountCodeApply mutation

Applies a code discount on the subscription draft.

Required access

write_own_subscription_contracts access scope.

On this page

• Interactive example
• Arguments
• 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;">appliedDiscount</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>
<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

Return fields

• appliedDiscount ([SubscriptionAppliedCodeDiscount](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionappliedcodediscount))
  The added 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.