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

DiscountCustomerGetsInput input object

Version unstable

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

appliesOnOneTimePurchase (Boolean)

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

appliesOnSubscription (Boolean)

Whether the discount applies on subscription items.

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.

Version 2021-01 (Release candidate)

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

appliesOnOneTimePurchase (Boolean)

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

appliesOnSubscription (Boolean)

Whether the discount applies on subscription items.

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.

Version 2020-10 (Latest)

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.

Version 2020-07

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.

Version 2020-04

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.

Version 2020-01

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.

Version 2019-10 (Unsupported)

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.

Version 2019-07 (Unsupported)

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.

Version 2019-04 (Unsupported)

Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

Input fields

items (DiscountItemsInput)

The IDs of the items that the customer gets. The items can be either collections or products.

value (DiscountCustomerGetsValueInput)

The quantity of items discounted and the discount value.