Retrieve usage alert group states
A usage alert group tracks the physical amount of included usage that a subscription consumes in a rating period. A subscription can have multiple usage alert groups, for example, a mobile subscription may have a usage alert group of 100 minutes for local calls and a usage alert group of 1 GB for mobile data downloads.
Smile resets the value of each usage alert group to 0 at the start of each rating period and when a subscription changes plan. The usage alert group limit is pro-rated for incomplete rating periods. Smile can perform an action when a subscription exceeds the value of a usage alert group, for example, suspend or shape the subscription.
Retrieving usage alert group states lets you view information about the quantity of included usage that a customer has consumed in the current rating period.
- getSubscriptionUsageAlertGroups() returns information about all usage alert groups for a subscription.
- getSubscriptionUsageAlertGroup() returns information about a specified usage alert group.