Anchor to section titled 'undefined'

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.

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?
Hide code
Mutation reference
Copy
mutation subscriptionDraftFreeShippingDiscountUpdate($discountId: ID!, $draftId: ID!, $input: SubscriptionFreeShippingDiscountInput!) {
  subscriptionDraftFreeShippingDiscountUpdate(discountId: $discountId, draftId: $draftId, input: $input) {
    discountUpdated {
      # SubscriptionManualDiscount fields
    }
    draft {
      # SubscriptionDraft fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "discountId": "gid://shopify/<objectName>/10079785100",
  "draftId": "gid://shopify/<objectName>/10079785100",
  "input": {
    "recurringCycleLimit": 1,
    "title": "<your-title>"
  }
}
input SubscriptionFreeShippingDiscountInput {
  recurringCycleLimit: Int
  title: String
}