subscriptionDraftDiscountRemove

mutation

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

Removes a subscription discount from a subscription draft.

Arguments

Anchor to discountIddiscountId • ID!required: The gid of the subscription draft discount to remove.
Anchor to draftIddraftId • ID!required: The gid of the subscription contract draft to remove a subscription discount from.

Was this section helpful?

Anchor to SubscriptionDraftDiscountRemovePayload returnsSubscriptionDraftDiscountRemovePayload returns

Anchor to discountRemoveddiscountRemoved • SubscriptionDiscount: The removed subscription draft 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 subscriptionDraftDiscountRemove($discountId: ID!, $draftId: ID!) {
2  subscriptionDraftDiscountRemove(discountId: $discountId, draftId: $draftId) {
3    discountRemoved {
4      # SubscriptionDiscount fields
5    }
6    draft {
7      # SubscriptionDraft fields
8    }
9    userErrors {
10      field
11      message
12    }
13  }
14}

Input

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

{
  "discountId": "gid://shopify/<objectName>/10079785100",
  "draftId": "gid://shopify/<objectName>/10079785100"
}