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

DiscountCodeFreeShippingInput input object

Version unstable

Specifies input field to create or update free shipping code discount.

Input fields

appliesOnOneTimePurchase (Boolean)

Whether the discount applies on regular one-time-purchase items.

appliesOnSubscription (Boolean)

Whether the discount applies on subscription items.

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

maximumShippingPrice (Decimal)

The maximum shipping price that qualifies for the discount.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

recurringCycleLimit (Int)

The number of times a discount applies on recurring purchases (subscriptions).

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.

Version 2021-01 (Release candidate)

Specifies input field to create or update free shipping code discount.

Input fields

appliesOnOneTimePurchase (Boolean)

Whether the discount applies on regular one-time-purchase items.

appliesOnSubscription (Boolean)

Whether the discount applies on subscription items.

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

maximumShippingPrice (Decimal)

The maximum shipping price that qualifies for the discount.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

recurringCycleLimit (Int)

The number of times a discount applies on recurring purchases (subscriptions).

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.

Version 2020-10 (Latest)

Specifies input field to create or update free shipping code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

maximumShippingPrice (Decimal)

The maximum shipping price that qualifies for the discount.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.

Version 2020-07

Specifies input field to create or update free shipping code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.

Version 2020-04

Specifies input field to create or update free shipping code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.

Version 2020-01

Specifies input field to create or update free shipping code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.

Version 2019-10 (Unsupported)

Specifies input field to create or update free shipping code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.

Version 2019-07 (Unsupported)

Specifies input field to create or update free shipping code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.

Version 2019-04 (Unsupported)

Specifies input field to create or update free shipping code discount.

Input fields

appliesOncePerCustomer (Boolean)

Whether the discount can be applied only once per customer.

code (String)

The code to use the discount.

customerSelection (DiscountCustomerSelectionInput)

The customers that can use the discount.

destination (DiscountShippingDestinationSelectionInput)

A list of destinations where the discount will apply.

endsAt (DateTime)

The date and time when the discount ends. For open-ended discounts, use null.

minimumRequirement (DiscountMinimumRequirementInput)

The minimum subtotal or quantity that's required for the discount to be applied.

startsAt (DateTime)

The date and time when the discount starts.

title (String)

The title of the discount.

usageLimit (Int)

The maximum number of times that the discount can be used. For open-ended discounts, use null.