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


Home > Aria6 core api > set_client_usg_ptd_threshold


Set the Billing-Period-To-Date unbilled usage threshold amount on the account for client event notifications.

Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
acct_no long 22 Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  amount double 38 New period-to-date threshold amount that triggers client email notices when crossed over or under.
  usage_unit_thresholds array    
  plan_no long   Unique plan identifier.
  usage_type_no long   The Aria-assigned usage type number to set the threshold unit amount per specific usage type.
  usage_type_code string 22 Client-assigned identifier for the type to set the threshold unit amount per specific usage type. Either this field OR "usage_type_no" must be passed into the API to denote which usage type to set the threshold unit.
  threshold_units double   The total number of threshold units
  threshold_level_no long   Indicates the level no of the threshold value
  threshold_level_value double   No units for the threshold level
  alt_caller_id string 30 Person or process that submitted the API call. This can be someone's user ID, or the name of an application.
  optional_transaction_qualifiers array   Array of additional values you can associate with this API call.
  qualifier_name string 100 Name of the field you want to associate with this API call.
  qualifier_value string 100 Corresponding value of the field you want to associate with this API call.

Output Arguments

Field Name Field Type Description
error_code long Aria-assigned error identifier. 0 indicates no error.
error_msg string Description of any error that occurred. "OK" if there was no error.

You must to post a comment.
Last modified
14:43, 2 Feb 2017


This page has no custom tags.


This page has no classifications.