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

DiscountCustomerGets object

Version unstable

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

appliesOnOneTimePurchase (Boolean!)

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

appliesOnSubscription (Boolean!)

Whether the discount applies on subscription items.

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets

Version 2021-01 (Release candidate)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

appliesOnOneTimePurchase (Boolean!)

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

appliesOnSubscription (Boolean!)

Whether the discount applies on subscription items.

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets

Version 2020-10 (Latest)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets

Version 2020-07

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets

Version 2020-04

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets

Version 2020-01

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets

Version 2019-10 (Unsupported)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets

Version 2019-07 (Unsupported)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets

Version 2019-04 (Unsupported)

The qualifying items in an order, the quantity of each one, and the total value of the discount.

Required access

Apps must have read_discounts access scope.

Fields

items (DiscountItems!)

The items to which the discount applies.

value (DiscountCustomerGetsValue!)

Entitled quantity and the discount value.

Types that return DiscountCustomerGets