Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 1.43 KB

File metadata and controls

21 lines (14 loc) · 1.43 KB

LoyaltyBalanceWithTier

Point balance of a ledger in the Loyalty Program.

Properties

Name Type Description Notes
activePoints BigDecimal Total amount of points awarded to this customer and available to spend. [optional]
pendingPoints BigDecimal Total amount of points awarded to this customer but not available until their start date. [optional]
spentPoints BigDecimal Total amount of points already spent by this customer. [optional]
expiredPoints BigDecimal Total amount of points awarded but never redeemed. They cannot be used anymore. [optional]
negativePoints BigDecimal Total amount of negative points. This implies that `activePoints` is `0`. [optional]
currentTier Tier [optional]
projectedTier ProjectedTier [optional]
pointsToNextTier BigDecimal The number of points required to move up a tier. [optional]
nextTierName String The name of the next higher tier level in the loyalty program. Note: - Returns `null` if the customer has reached the highest available tier. - Returns the lowest level tier name if the customer is not currently assigned to any tier. [optional]