subscriptionDraftFreeShippingDiscountUpdate
mutation

Choose a version:

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

Updates a subscription free shipping discount on a subscription draft.

Anchor to section titled 'Arguments'

Arguments

Anchor to discountId discountId ID! required: The gid of the Subscription Discount to update.
Anchor to draftId draftId ID! required: The ID of the Subscription Contract draft to update a subscription discount on.
Anchor to input input SubscriptionFreeShippingDiscountInput! required: The properties to update on the Subscription Free Shipping Discount.

Was this section helpful?

Anchor to section titled 'SubscriptionDraftFreeShippingDiscountUpdatePayload returns'

SubscriptionDraftFreeShippingDiscountUpdatePayload returns

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

Was this section helpful?

Code examples for MUTATION: subscriptionDraftFreeShippingDiscountUpdate

Query Reference for MUTATION: subscriptionDraftFreeShippingDiscountUpdate

"mutation subscriptionDraftFreeShippingDiscountUpdate($discountId: ID!, $draftId: ID!, $input: SubscriptionFreeShippingDiscountInput!) {\n  subscriptionDraftFreeShippingDiscountUpdate(discountId: $discountId, draftId: $draftId, input: $input) {\n    discountUpdated {\n      # SubscriptionManualDiscount fields\n    }\n    draft {\n      # SubscriptionDraft fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: subscriptionDraftFreeShippingDiscountUpdate

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

Schema Reference for MUTATION: subscriptionDraftFreeShippingDiscountUpdate

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

Display Examples for MUTATION: subscriptionDraftFreeShippingDiscountUpdate

[]

subscriptionDraftFreeShippingDiscountUpdatemutation

Arguments

SubscriptionDraftFreeShippingDiscountUpdatePayload returns

subscriptionDraftFreeShippingDiscountUpdate
mutation