subscriptionDraftDiscountAdd

mutation

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

Adds a subscription discount to a subscription draft.

Arguments

Anchor to draftIddraftId • ID!required: The ID of the Subscription Contract draft to add a subscription discount to.
Anchor to inputinput • SubscriptionManualDiscountInput!required: The properties of the new Subscription Discount.

Was this section helpful?

Anchor to SubscriptionDraftDiscountAddPayload returnsSubscriptionDraftDiscountAddPayload returns

Anchor to discountAddeddiscountAdded • SubscriptionManualDiscount: 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 subscriptionDraftDiscountAdd($draftId: ID!, $input: SubscriptionManualDiscountInput!) {
2  subscriptionDraftDiscountAdd(draftId: $draftId, input: $input) {
3    discountAdded {
4      # SubscriptionManualDiscount 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  "input": {
4    "entitledLines": {
5      "all": true,
6      "lines": ""
7    },
8    "recurringCycleLimit": 1,
9    "title": "<your-title>",
10    "value": {
11      "fixedAmount": "",
12      "percentage": 1
13    }
14  }
15}

{
  "draftId": "gid://shopify/<objectName>/10079785100",
  "input": {
    "entitledLines": {
      "all": true,
      "lines": ""
    },
    "recurringCycleLimit": 1,
    "title": "<your-title>",
    "value": {
      "fixedAmount": "",
      "percentage": 1
    }
  }
}

input SubscriptionManualDiscountInput {
  entitledLines: SubscriptionManualDiscountEntitledLinesInput
  recurringCycleLimit: Int
  title: String
  value: SubscriptionManualDiscountValueInput
}

input SubscriptionManualDiscountEntitledLinesInput {
  all: Boolean
  lines: SubscriptionManualDiscountLinesInput
}

input SubscriptionManualDiscountValueInput {
  fixedAmount: SubscriptionManualDiscountFixedAmountInput
  percentage: Int
}