Set Thresholds on an Account via API

Last updated
Save as PDF

Overview

You can set thresholds on an account via the set_usage_threshold_m API by following the steps below.

Setting Thresholds on an Account Via API

Call the set_usage_threshold_m API.
Provide values for the following:

client_no
auth_key
acct_no
usage_type no
unit_threshold_level1
unit_threshold_level2
unit_threshold_level3
unit_threshold_level4

To confirm this API setting, search for the account in the UI.
Navigate to Usage > Unit-based Usage Monitoring tab.

Note: If you cannot see the Unit-based Usage Monitoring tab, please see the prerequisite within Setting Up Usage Unit Thresholds.

A checkbox should display next to the usage type provided via the API call and all 1^st Level, 2^nd Level, 3^rd Level, and 4^th Level values that were submitted via the API should appear.

When usage for the usage type provided via the API crosses over the Client Notice MTD Thresholds provided via the API, the following event fires:

Account's unbilled unit usage value is now OVER OR EQUAL TO the client-defined MTD threshold value.