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 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 subscriptionDraftDiscountCodeApply($draftId: ID!, $redeemCode: String!) {

subscriptionDraftDiscountCodeApply(draftId: $draftId, redeemCode: $redeemCode) {

appliedDiscount {

# SubscriptionAppliedCodeDiscount fields

}

draft {

# SubscriptionDraft fields

}

userErrors {

field

message

}

{

"draftId": "gid://shopify/<objectName>/10079785100",

"redeemCode": "<your-redeemCode>"

}