API version: unstable
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

subscriptionDraftFreeShippingDiscountUpdate mutation

Version unstable

Updates a subscription free shipping discount on 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.


Arguments

discountId ( ID! ) required

The gid of the Subscription Discount to update.

draftId ( ID! ) required

The ID of the Subscription Contract draft to update a subscription discount on.

input ( SubscriptionFreeShippingDiscountInput! ) required

The properties to update on the 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

discountUpdated (SubscriptionManualDiscount)

The updated Subscription Discount.

draft (SubscriptionDraft)

The Subscription Contract draft object.

userErrors ([SubscriptionDraftUserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Updates a subscription free shipping discount on 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.


Arguments

discountId ( ID! ) required

The gid of the Subscription Discount to update.

draftId ( ID! ) required

The ID of the Subscription Contract draft to update a subscription discount on.

input ( SubscriptionFreeShippingDiscountInput! ) required

The properties to update on the 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

discountUpdated (SubscriptionManualDiscount)

The updated Subscription Discount.

draft (SubscriptionDraft)

The Subscription Contract draft object.

userErrors ([SubscriptionDraftUserError!]!)

List of errors that occurred executing the mutation.