Skip to main content
Aria Knowledge Central

Manage Unbilled Usage Balances with API Calls

Overview

You can call several APIs to set the unbilled usage balance threshold for accounts to:

  • trigger email messages and event notifications,
  • reset an account's unbilled usage balance to zero, and 
  • obtain information about an account’s unbilled usage.

Using API Calls to Manage Unbilled Usage Balances

  • Use the API call set_usage_threshold_m to set the Billing-Period-To-Date or Month-To-Date unbilled usage threshold amount on the master plan instance for client-level event notifications or master plan instance-level event notifications. In addition, the API also allows setting threshold levels.
     
  • Use the API call set_usg_mtd_ptd_bal_m to reset the client or master plan instance Billing-Period-To-Date or Month-To-Date unbilled usage balance to zero.

    Note: Resetting unbilled usage balances affects only email messages and event notifications. Actual balances owed by customers for accrued usage will not be affected.

  • Use the get_unbilled_usage_summary_m call to obtain information about an account’s unbilled usage balances, unapplied service credit balance, and thresholds.

Note: For more information about these API calls, please refer to the API documentation.

  • Was this article helpful?