Usage Meter

The Usage Meter feature allows administrators to set monthly combined data usage thresholds for subscribers. When a subscriber's monthly usage reaches the configured threshold, a webhook trigger is fired to notify external systems.

Key Features

Monthly Threshold: Set a combined (upload + download) data usage threshold in kilobytes per subscriber.
Automatic Resets: Thresholds automatically reset monthly based on the subscriber's configured timezone.
Webhook Integration: Trigger subscriber-usage-meter-triggered webhooks when thresholds are reached.
Per-Subscriber Configuration: Each subscriber has independent threshold settings.

Use Cases

Notify users when approaching data caps
Integrate with billing systems to warn of overage charges
Trigger alerts for network management
Automate provisioning of additional data packages

API Documentation

For API reference material, see Subscriber Management > API > Usage Meter.

Managing Usage Meters

Use the Subscriber Management API to:

Set a threshold - POST to /v1/usage-meter/{subscriber_id} with monthly_combined_trigger_kb
Disable threshold webhooks - POST monthly_combined_trigger_kb as 0
Reset trigger state - DELETE /v1/usage-meter/{subscriber_id}

Webhook Trigger

When a subscriber's usage reaches the threshold, the system fires a subscriber-usage-meter-triggered webhook in the radius-accounting context, including:

Subscriber information
monthly_combined_kb: Total usage in KB for the current month
monthly_month: The current billing month (YYYY-MM)
monthly_combined_trigger_kb: The configured threshold in KB

For webhook configuration and examples, see Webhooks.