subscriptionDraftFreeShippingDiscountAdd
mutation

Choose a version:

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

Adds a subscription free shipping 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 free shipping discount to.
Anchor to input input SubscriptionFreeShippingDiscountInput! required: The properties of the new subscription free shipping discount.

Was this section helpful?

Anchor to section titled 'SubscriptionDraftFreeShippingDiscountAddPayload returns'

SubscriptionDraftFreeShippingDiscountAddPayload returns

Anchor to SubscriptionDraftFreeShippingDiscountAddPayload.discountAdded discountAdded SubscriptionManualDiscount: The added subscription free shipping discount.
Anchor to SubscriptionDraftFreeShippingDiscountAddPayload.draft draft SubscriptionDraft: The subscription contract draft object.
Anchor to SubscriptionDraftFreeShippingDiscountAddPayload.userErrors userErrors [SubscriptionDraftUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: subscriptionDraftFreeShippingDiscountAdd

Query Reference for MUTATION: subscriptionDraftFreeShippingDiscountAdd

"mutation subscriptionDraftFreeShippingDiscountAdd($draftId: ID!, $input: SubscriptionFreeShippingDiscountInput!) {\n  subscriptionDraftFreeShippingDiscountAdd(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: subscriptionDraftFreeShippingDiscountAdd

"{\n  \"draftId\": \"gid://shopify/<objectName>/10079785100\",\n  \"input\": {\n    \"recurringCycleLimit\": 1,\n    \"title\": \"<your-title>\"\n  }\n}"

Schema Reference for MUTATION: subscriptionDraftFreeShippingDiscountAdd

"input SubscriptionFreeShippingDiscountInput {\n  recurringCycleLimit: Int\n  title: String\n}\n"

Display Examples for MUTATION: subscriptionDraftFreeShippingDiscountAdd

[]

subscriptionDraftFreeShippingDiscountAddmutation

Arguments

SubscriptionDraftFreeShippingDiscountAddPayload returns

subscriptionDraftFreeShippingDiscountAdd
mutation