Class AmountDiscount

Represents an amount-off discount in the discount plan, for example “$10 off all orders $100 or more”.

Property Summary 

PropertyDescription
amount: Number (read-only)Returns the discount amount, for example 10.00 for a “$10 off” discount.

Constructor Summary 

ConstructorDescription
AmountDiscount(Number)Create an amount-discount on the fly.

Method Summary 

MethodDescription
getAmount()Returns the discount amount, for example 10.00 for a “$10 off” discount.

Methods inherited from class Discount 

getItemPromotionTiers, getPromotion, getPromotionTier, getQuantity, getType

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

amount 

amount: Number (read-only)

Returns the discount amount, for example 10.00 for a "$10 off" discount.


Constructor Details 

AmountDiscount(Number) 

AmountDiscount(amount: Number)

Create an amount-discount on the fly. Can be used to create a custom price adjustment.

Parameters:

  • amount - amount off, e.g. 15.00 for a "15$ off" discount

Method Details 

getAmount() 

getAmount(): Number

Returns the discount amount, for example 10.00 for a "$10 off" discount.

Returns:

  • Discount amount