Skip to content

Files

Latest commit

Jan 16, 2025
368a5f5 · Jan 16, 2025

History

History
18 lines (14 loc) · 1.65 KB

LedgerInfo.md

File metadata and controls

18 lines (14 loc) · 1.65 KB

LedgerInfo

The balance in a Loyalty Program for some Customer.

Properties

Name Type Description Notes
current_balance float Sum of currently active points.
pending_balance float Sum of pending points.
expired_balance float DEPRECATED Value is shown as 0.
spent_balance float DEPRECATED Value is shown as 0.
tentative_current_balance float The tentative points balance, reflecting the `currentBalance` and all point additions and deductions within the current open customer session. When the session is closed, the effects are applied and the `currentBalance` is updated to this value. Note: Tentative balances are specific to the current session and do not take into account other open sessions for the given customer.
tentative_pending_balance float The tentative points balance, reflecting the `pendingBalance` and all point additions with a future activation date within the current open customer session. When the session is closed, the effects are applied and the `pendingBalance` is updated to this value. Note: Tentative balances are specific to the current session and do not take into account other open sessions for the given customer. [optional]
current_tier Tier [optional]
points_to_next_tier float Points required to move up a tier. [optional]

[Back to Model list] [Back to API list] [Back to README]