Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!

 

Home > User Documentation > Usage > Configure Usage > Unbilled Usage Balances > Manage Unbilled Usage Balances with API Calls

Manage Unbilled Usage Balances with API Calls

Overview

Using API calls allows you to set the unbilled usage balance threshold for accounts in order to:

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

Using API Calls to Manage Unbilled Usage Balances

Use the API calls as described below:

  • To set the thresholds that will trigger email messages to the account holder:
    • Use the set_acct_usg_mtd_threshold API call to set an account’s month-to-date unbilled usage balance threshold for triggering email messages to the customer.
    • Use the set_acct_usg_ptd_threshold API call to set an account’s billing-period-to-date unbilled usage balance threshold for triggering email messages to the customer.
  • To set the thresholds that will trigger event notifications to your system(s):
    • Use the set_client_usg_mtd_threshold API call to set an account’s month-to-date unbilled usage balance threshold for triggering event notifications to your system(s).
    • Use the set_client_usg_ptd_threshold API call to set an account’s billing-period-to-date unbilled usage balance threshold for triggering event notifications to your system(s).
  • Use the reset_usg_mtd_bal API call to reset an account's month-to-date unbilled usage balance to zero.
  • Use the reset_usg_ptd_bal API call to reset an account's billing-period-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 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.

You must to post a comment.
Last modified

Tags

Classifications

This page has no classifications.