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 Arguments

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?

Examples

subscriptionDraftFreeShippingDiscountUpdate reference

Mutation Reference

mutation subscriptionDraftFreeShippingDiscountUpdate($draftId: ID!, $discountId: ID!, $input: SubscriptionFreeShippingDiscountInput!) {

subscriptionDraftFreeShippingDiscountUpdate(draftId: $draftId, discountId: $discountId, input: $input) {

discountUpdated {

# SubscriptionManualDiscount fields

}

draft {

# SubscriptionDraft fields

}

userErrors {

field

message

}

Input

{

"draftId": "gid://shopify/<objectName>/10079785100",

"discountId": "gid://shopify/<objectName>/10079785100",

"input": {

"title": "<your-title>",

"recurringCycleLimit": 1

}

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

input SubscriptionFreeShippingDiscountInput {
  title: String
  recurringCycleLimit: Int
}