subscriptionDraftDiscountCodeApply
mutation

Choose a version:

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

Applies a code discount on the subscription draft.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'SubscriptionDraftDiscountCodeApplyPayload returns'

SubscriptionDraftDiscountCodeApplyPayload returns

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

Was this section helpful?

Code examples for MUTATION: subscriptionDraftDiscountCodeApply

Query Reference for MUTATION: subscriptionDraftDiscountCodeApply

"mutation subscriptionDraftDiscountCodeApply($draftId: ID!, $redeemCode: String!) {\n  subscriptionDraftDiscountCodeApply(draftId: $draftId, redeemCode: $redeemCode) {\n    appliedDiscount {\n      # SubscriptionAppliedCodeDiscount fields\n    }\n    draft {\n      # SubscriptionDraft fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionDraftDiscountCodeApply

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

Schema Reference for MUTATION: subscriptionDraftDiscountCodeApply

""

Display Examples for MUTATION: subscriptionDraftDiscountCodeApply

[]

subscriptionDraftDiscountCodeApplymutation

Arguments

SubscriptionDraftDiscountCodeApplyPayload returns

subscriptionDraftDiscountCodeApply
mutation