subscriptionDraftDiscountAdd
mutation

Choose a version:

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

Adds a subscription discount to a subscription draft.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'SubscriptionDraftDiscountAddPayload returns'

SubscriptionDraftDiscountAddPayload returns

Anchor to SubscriptionDraftDiscountAddPayload.discountAdded discountAdded SubscriptionManualDiscount: The added Subscription Discount.
Anchor to SubscriptionDraftDiscountAddPayload.draft draft SubscriptionDraft: The Subscription Contract draft object.
Anchor to SubscriptionDraftDiscountAddPayload.userErrors userErrors [SubscriptionDraftUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: subscriptionDraftDiscountAdd

Query Reference for MUTATION: subscriptionDraftDiscountAdd

"mutation subscriptionDraftDiscountAdd($draftId: ID!, $input: SubscriptionManualDiscountInput!) {\n  subscriptionDraftDiscountAdd(draftId: $draftId, input: $input) {\n    discountAdded {\n      # SubscriptionManualDiscount fields\n    }\n    draft {\n      # SubscriptionDraft fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionDraftDiscountAdd

"{\n  \"draftId\": \"gid://shopify/<objectName>/10079785100\",\n  \"input\": {\n    \"entitledLines\": {\n      \"all\": true,\n      \"lines\": {\n        \"add\": [\n          \"gid://shopify/<objectName>/10079785100\"\n        ],\n        \"remove\": [\n          \"gid://shopify/<objectName>/10079785100\"\n        ]\n      }\n    },\n    \"recurringCycleLimit\": 1,\n    \"title\": \"<your-title>\",\n    \"value\": {\n      \"fixedAmount\": {\n        \"amount\": 1.1,\n        \"appliesOnEachItem\": true\n      },\n      \"percentage\": 1\n    }\n  }\n}"

Schema Reference for MUTATION: subscriptionDraftDiscountAdd

"input SubscriptionManualDiscountInput {\n  entitledLines: SubscriptionManualDiscountEntitledLinesInput\n  recurringCycleLimit: Int\n  title: String\n  value: SubscriptionManualDiscountValueInput\n}\n\ninput SubscriptionManualDiscountEntitledLinesInput {\n  all: Boolean\n  lines: SubscriptionManualDiscountLinesInput\n}\n\ninput SubscriptionManualDiscountValueInput {\n  fixedAmount: SubscriptionManualDiscountFixedAmountInput\n  percentage: Int\n}\n"

Display Examples for MUTATION: subscriptionDraftDiscountAdd

[]

subscriptionDraftDiscountAddmutation

Arguments

SubscriptionDraftDiscountAddPayload returns

subscriptionDraftDiscountAdd
mutation