Skip to main content
Aria Knowledge Central

Events in the Usage Monitoring Class

Overview

The Usage Monitoring Event Class encapsulates events triggered by the addition or modification of usage monitoring data within Aria’s billing system. These events are outbound notifications from Aria (indicated by sender="A") and include account details, unbilled usage summaries, and optional usage unit thresholds, enabling external systems to track usage patterns, enforce limits, or trigger actions like customer notifications.

Purpose and Use Case

The Usage Monitoring Event Class enables real-time tracking of unbilled usage, notifying external systems when usage crosses client-defined thresholds (e.g., monetary or unit-based). For instance, if an account’s MTD measured usage exceeds mtd_cli_threshold_amt (action="A" or "M"), the notification provides the account details, usage summary, and threshold data, allowing the client system to enforce limits, alert customers, or adjust services. It supports usage-based billing and resource management.

In essence, the Usage Monitoring Event Class is a detailed notification mechanism for monitoring and reporting unbilled usage in Aria, linking usage data to accounts and thresholds for proactive management and integration.

You must subscribe to this event class, then select from among the events listed below, to receive these event notifications.

Note: Reference notated sample XML payloads for this event class.

XSD Files

Below are the Stage Future, Production and Stage Current XSD files.

Versions Stage Future Production
2.0
1.0

List of Events

Below is a list of the events in the usage monitoring class. (The events listed may appear in a different order in the UI.)

Event ID Label Description
1101 MPI's unbilled usage value is now OVER OR EQUAL TO client-defined MTD (month-to-date) threshold value. The total currency value of a Master Plan Instance's month-to-date unbilled usage was previously UNDER the client-defined threshold amount for system notification but is now OVER OR EQUAL TO that threshold.
1102 MPI's unbilled usage value has crossed UNDER client-defined MTD threshold value. The total currency value of a Master Plan Instance's month-to-date unbilled usage was previously OVER OR EQUAL TO the client-defined threshold amount for system notification but is now UNDER that amount.
1103 MPI's unbilled usage value is now OVER OR EQUAL TO client-defined PTD (billing-period-to-date) threshold value. The total currency value of a Master Plan Instance's master billing-period-to-date unbilled usage was previously UNDER the client-defined threshold amount for system notification but is now OVER OR EQUAL TO that threshold.
1104 MPI's unbilled usage value has crossed UNDER client-defined PTD threshold value. The total currency value of a Master Plan Instance's master billing-period-to-date unbilled usage was previously OVER OR EQUAL TO the client-defined threshold amount for system notification but is now UNDER that threshold.
1105 MPI's unbilled usage value is now OVER OR EQUAL TO client-defined MTD threshold percentage. The total currency value of a Master Plan Instance's month-to-date unbilled usage was previously UNDER the client-defined threshold percentage for system notification but is now OVER OR EQUAL TO that threshold.
1106 MPI's unbilled usage value has crossed UNDER client-defined MTD threshold percentage. The total currency value of a Master Plan Instance's month-to-date unbilled usage was previously OVER OR EQUAL TO the client-defined threshold percentage for system notification but is now UNDER that threshold.
1107 MPI's unbilled usage value is now OVER OR EQUAL TO client-defined PTD threshold percentage. The total currency value of a Master Plan Instance's master billing-period-to-date unbilled usage was previously UNDER the client-defined threshold percentage for system notification but is now OVER OR EQUAL TO that threshold.
1108 MPI's unbilled usage value has crossed UNDER client-defined PTD threshold percentage. The total currency value of a Master Plan Instance's master billing-period-to-date unbilled usage was previously OVER OR EQUAL TO the client-defined threshold percentage for system notification but is now UNDER that threshold.
1109 MPI's unbilled unit usage value is now OVER OR EQUAL TO the client-defined MTD threshold value. The Master Plan Instance's month-to-date unbilled unit usage was previously UNDER the client-defined threshold usage unit for system notification, but is now OVER OR EQUAL TO that usage unit.
1110 MPI's unbilled unit usage value is now UNDER client-defined MTD threshold value. The Master Plan Instance's month-to-date unbilled unit usage was previously OVER OR EQUAL TO the client-defined threshold usage unit for system notification, but is now UNDER that usage unit.
1111 MPI's unbilled unit usage value is now OVER OR EQUAL TO client-defined PTD threshold value. The Master Plan Instance's master billing-period-to-date unbilled unit usage was previously UNDER the client-defined threshold usage unit for system notification, but is now OVER OR EQUAL TO that usage unit.
1112 MPI's unbilled unit usage value is now UNDER client-defined PTD threshold value. The Master Plan Instance's master billing-period-to-date unbilled unit usage was previously OVER OR EQUAL TO the client-defined threshold usage unit for system notification, but is now UNDER that usage unit.
  • Was this article helpful?