Retrieve value pool states
A value pool tracks the monetary value of included usage that a subscription spends in a rating period. A subscription can have multiple value pools, for example, a mobile subscription may have a $100 value pool for local calls and a $50 value pool for mobile data downloads.
Smile resets each value pool to $0 at the start of each rating period and when a subscription changes plan. The value pool limit is pro-rated for incomplete rating periods.
Retrieving value pool states lets you view information about the amount of included value that a customer has spent in the current rating period.
The following methods retrieve value pool states:
- getSubscriptionValuePoolStates() returns information about all value pools for a subscription.
- getSubscriptionValuePoolState() returns information about a specified value pool.