subscriptionDraftDiscountCodeApply

mutation

Requires write_own_subscription_contracts access scope. Also: The user must have manage_orders_information permission.

Applies a code discount on the subscription draft.

Arguments

Anchor to draftIddraftId • ID!required: The gid of the subscription contract draft to apply a subscription code discount on.
Anchor to redeemCoderedeemCode • String!required: Code discount redeem code.

Was this section helpful?

Anchor to SubscriptionDraftDiscountCodeApplyPayload returnsSubscriptionDraftDiscountCodeApplyPayload returns

Anchor to appliedDiscountappliedDiscount • SubscriptionAppliedCodeDiscount: The added subscription discount.
Anchor to draftdraft • SubscriptionDraft: The subscription contract draft object.
Anchor to userErrorsuserErrors • [SubscriptionDraftUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation subscriptionDraftDiscountCodeApply($draftId: ID!, $redeemCode: String!) {
2  subscriptionDraftDiscountCodeApply(draftId: $draftId, redeemCode: $redeemCode) {
3    appliedDiscount {
4      # SubscriptionAppliedCodeDiscount fields
5    }
6    draft {
7      # SubscriptionDraft fields
8    }
9    userErrors {
10      field
11      message
12    }
13  }
14}

Input

1{
2  "draftId": "gid://shopify/<objectName>/10079785100",
3  "redeemCode": "<your-redeemCode>"
4}

{
  "draftId": "gid://shopify/<objectName>/10079785100",
  "redeemCode": "<your-redeemCode>"
}