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
String
The currency ISO code for the threshold. |
description
String
Describes the discount to the visitor. |
expires
Date | null
The date until the discount is valid. A null value means the discount has no expiry date. |
id
Number
The system ID for the discount object. |
includingTax
Boolean
Does the threshold include tax? Whatever value that may be in the cart. |
percentage
Number
The percentage discount given to the customer represented as an integer 0 - 100. |
reference
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
Date | null
The effective start date of the discount, or null if the discount was effective immediately. |
threshold
Money
The monetary threshold over which the discount is applicable. |
title
String
The human readable title for the discount structure. |
type
String
The type of discount as a String may be:
|
usageLimit
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. |