Discount

Extends Object. The Discount Object may represent a discount coupon in the Cart, a public sale event discount, or a discount structure assigned to a Contact.

Properties
currency

Type String

The currency ISO code for the threshold.

description

Type String

Describes the discount to the visitor.

expires

Type Date or Null

The date until the discount is valid. A null value means the discount has no expiry date.

id

Type Number

The system ID for the discount object.

includingTax

Type Boolean

Does the threshold include tax? Whatever value that may be in the cart.

percentage

Type Number

The percentage discount given to the customer represented as an integer 0 - 100.

reference

Type String

The custom reference/tracking number for the discount structure. This is the reference used by visitors when adding a coupon to Cart, but all discount structures have a reference for tracking purposes.

starts

Type Date or Null

The effective start date of the discount, or null if the discount was effective immediately.

threshold

Type Money

The monetary threshold over which the discount is applicable.

title

Type String

The human readable title for the discount structure.

type

Type String

The type of discount as a String may be:

  • contact
  • coupon
  • public
usageLimit

Type Number

The number of times a discount coupon may be used. This property is not applicable to other discount types. A value of 0 means unlimited.