subscriptionDraftFreeShippingDiscountUpdate

mutation

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.

Arguments

Anchor to discountIddiscountId • ID!required: The gid of the Subscription Discount to update.
Anchor to draftIddraftId • ID!required: The ID of the Subscription Contract draft to update a subscription discount on.
Anchor to inputinput • SubscriptionFreeShippingDiscountInput!required: The properties to update on the Subscription Free Shipping Discount.

Was this section helpful?

Anchor to SubscriptionDraftFreeShippingDiscountUpdatePayload returnsSubscriptionDraftFreeShippingDiscountUpdatePayload returns

Anchor to discountUpdateddiscountUpdated • SubscriptionManualDiscount: The updated 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 subscriptionDraftFreeShippingDiscountUpdate($discountId: ID!, $draftId: ID!, $input: SubscriptionFreeShippingDiscountInput!) {
2  subscriptionDraftFreeShippingDiscountUpdate(discountId: $discountId, draftId: $draftId, input: $input) {
3    discountUpdated {
4      # SubscriptionManualDiscount fields
5    }
6    draft {
7      # SubscriptionDraft fields
8    }
9    userErrors {
10      field
11      message
12    }
13  }
14}

Input

1{
2  "discountId": "gid://shopify/<objectName>/10079785100",
3  "draftId": "gid://shopify/<objectName>/10079785100",
4  "input": {
5    "recurringCycleLimit": 1,
6    "title": "<your-title>"
7  }
8}

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

input SubscriptionFreeShippingDiscountInput {
  recurringCycleLimit: Int
  title: String
}