API version 2021-01 Release candidate
API version 2020-10 Latest
API version 2020-07
API version 2020-04
API version 2020-01
API version 2019-10 Unsupported
API version 2019-07 Unsupported

subscriptionDraftFreeShippingDiscountAdd mutation

Version 2021-01 (Release candidate)

Adds a subscription free shipping discount to a subscription draft.

Required access

write_own_subscription_contracts access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


draftId ( ID! ) required

The ID of the subscription contract draft to add a subscription free shipping discount to.

input ( SubscriptionFreeShippingDiscountInput! ) required

The properties of the new subscription free shipping discount.

SubscriptionFreeShippingDiscountInput fields

recurringCycleLimit (Int)

The maximum number of times the subscription free shipping discount will be applied on orders.

title (String)

The title associated with the subscription free shipping discount.

Return fields

discountAdded (SubscriptionManualDiscount)

The added subscription free shipping discount.

draft (SubscriptionDraft)

The subscription contract draft object.

userErrors ([SubscriptionDraftUserError!]!)

List of errors that occurred executing the mutation.