subscriptionDraftFreeShippingDiscountAdd

mutation

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.

Arguments

Anchor to draftIddraftId • ID!required: The ID of the subscription contract draft to add a subscription free shipping discount to.
Anchor to inputinput • SubscriptionFreeShippingDiscountInput!required: The properties of the new subscription free shipping discount.

Was this section helpful?

Anchor to SubscriptionDraftFreeShippingDiscountAddPayload returnsSubscriptionDraftFreeShippingDiscountAddPayload returns

Anchor to discountAddeddiscountAdded • SubscriptionManualDiscount: The added subscription free shipping 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 subscriptionDraftFreeShippingDiscountAdd($draftId: ID!, $input: SubscriptionFreeShippingDiscountInput!) {
2  subscriptionDraftFreeShippingDiscountAdd(draftId: $draftId, input: $input) {
3    discountAdded {
4      # SubscriptionManualDiscount fields
5    }
6    draft {
7      # SubscriptionDraft fields
8    }
9    userErrors {
10      field
11      message
12    }
13  }
14}

Input

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

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

input SubscriptionFreeShippingDiscountInput {
  recurringCycleLimit: Int
  title: String
}