set_usage_threshold_m
Summary
| API Name | set_usage_threshold_m |
|---|---|
| Class | account_services_m |
| Update Version | 6.49 |
Description
This API sets 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.
Inputs
| Name | Type | Length | Required | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| client_no | long | 22 | Yes |
Aria-assigned unique identifier indicating the Aria client providing service to this account. |
||||||
| auth_key | string | 32 | No |
Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call. |
||||||
| acct_no | long | 22 | Yes |
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
||||||
| Start of mpi_usage_amount_thresholds object | ||||||||||
| mpi_usage_amount_thresholds | object | No | ||||||||
| Name | Type | Length | Required | Description | ||||||
| ▶master_plan_instance_no | long | 22 | No |
Aria generated unique identifier for the master plan instance. Alternative field: client_master_plan_instance_id |
||||||
| ▶client_master_plan_instance_id | string | 100 | No |
Client-defined unique identifier for the master plan instance. Alternative field: master_plan_instance_no |
||||||
| Start of amount_threshold_dest_types object | ||||||||||
| ▶amount_threshold_dest_types | object | No | ||||||||
| Name | Type | Length | Required | Description | ||||||
| ▶▶threshold_dest_type | string | 1 | No |
Returns a string representing the threshold destination type either Stack S or Client C. Allowed values:
|
||||||
| Start of amount_threshold_balance_types object | ||||||||||
| ▶▶amount_threshold_balance_types | object | No | ||||||||
| Name | Type | Length | Required | Description | ||||||
| ▶▶▶threshold_balance_type | string | 3 | No |
Returns a string representing the threshold balance type either month-to-date or billing-period-to-date. Allowed values:
|
||||||
| ▶▶▶amount | double | 22 | No |
The threshold amount which, when crossed over or under unbilled usage balance, triggers an email notification or events. |
||||||
| End of amount_threshold_balance_types object | ||||||||||
| End of amount_threshold_dest_types object | ||||||||||
| End of mpi_usage_amount_thresholds object | ||||||||||
| Start of instance_usage_unit_thresholds object | ||||||||||
| instance_usage_unit_thresholds | object | No | ||||||||
| Name | Type | Length | Required | Description | ||||||
| ▶plan_instance_no | long | 22 | No |
Aria generated unique identifier for the plan instance. Alternative field: client_plan_instance_id |
||||||
| ▶client_plan_instance_id | string | 100 | No |
Client-defined unique identifier for the plan instance. Alternative field: plan_instance_no |
||||||
| Start of usage_services object | ||||||||||
| ▶usage_services | object | No | ||||||||
| Name | Type | Length | Required | Description | ||||||
| ▶▶usage_type_no | long | Yes |
The Aria-assigned usage type number to set the threshold unit amount per specific usage type. Alternative required field: client_usage_type_id |
|||||||
| ▶▶client_usage_type_id | string | 22 | Yes |
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. Alternative required field: usage_type_no |
||||||
| Start of unit_threshold_dest_types object | ||||||||||
| ▶▶unit_threshold_dest_types | object | No | ||||||||
| Name | Type | Length | Required | Description | ||||||
| ▶▶▶threshold_dest_type | string | 1 | No |
Returns a string representing the threshold destination type either Stack S or Client C. Allowed values:
|
||||||
| Start of unit_threshold_balance_types object | ||||||||||
| ▶▶▶unit_threshold_balance_types | object | No | ||||||||
| Name | Type | Length | Required | Description | ||||||
| ▶▶▶▶threshold_balance_type | string | 3 | No |
Returns a string representing the threshold balance type either month-to-date or billing-period-to-date. Allowed values:
|
||||||
| ▶▶▶▶threshold_reference_units | double | No |
The total number of threshold units |
|||||||
| Start of notification_levels object | ||||||||||
| ▶▶▶▶notification_levels | object | No | ||||||||
| Name | Type | Length | Required | Description | ||||||
| ▶▶▶▶▶level_no | long | No |
Indicates the level no of the threshold value |
|||||||
| ▶▶▶▶▶notification_percentage | double | No |
No units for the threshold level |
|||||||
| End of notification_levels object | ||||||||||
| End of unit_threshold_balance_types object | ||||||||||
| End of unit_threshold_dest_types object | ||||||||||
| End of usage_services object | ||||||||||
| End of instance_usage_unit_thresholds object | ||||||||||
Outputs
| Name | Type | Length | Required | Description |
|---|---|---|---|---|
| error_code | long | No |
Aria-assigned error identifier. 0 indicates no error. |
|
| error_msg | string | No |
Description of any error that occurred. "OK" if there was no error. |