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

mutation subscriptionDraftDiscountAdd($draftId: ID!, $input: SubscriptionManualDiscountInput!) {

subscriptionDraftDiscountAdd(draftId: $draftId, input: $input) {

discountAdded {

# SubscriptionManualDiscount fields

}

draft {

# SubscriptionDraft fields

}

userErrors {

field

message

}

Input

{

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

"input": {

"entitledLines": {

"all": true,

"lines": ""

"recurringCycleLimit": 1,

"title": "<your-title>",

"value": {

"fixedAmount": "",

"percentage": 1

}

{
  "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
}