Skip to main content
POST
/
v1.0
/
numbers
/
data-usage
json
{
  "ValueUnit": "MB",            //choice of KB, MB, GB, or TB
  "NotifyValue": 10,            //when reached, subscriber will be notified
  "ThrottleValue": 15,         //when reached, data speed will be throttled at speed given below
  "ThrottleSpeed": "1-mbps",   //choice of 1-mbps, 5-mbps, 20-mbps, 50-mbps, or 100-mbps
  "LimitValue": 20,             //data cap/limit (NOTE: values must be in increments and cannot be the same)
  "PhoneNumbers": [
    { "Number": "+12016093801" },
    { "Number": "+12232233180" }
  ]
}
{
  "Status": "Complete",
  "StatusMessage": "",
  "ValueUnit": "MB",
  "NotifyValue": 10,
  "ThrottleValue": 15,
  "ThrottleSpeed": "1-mbps",
  "LimitValue": 20,
  "PhoneNumbers": [
    {
      "Number": "+12016093801"
    },
    {
      "Number": "+12232233180"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
ValueUnit
enum<string>
required

Unit of data measurement

Available options:
KB,
MB,
GB,
TB
Example:

"MB"

​
LimitValue
integer
required

Maximum data cap/limit

Example:

20

​
PhoneNumbers
object[]
required

Array of phone numbers to apply data limits to

​
NotifyValue
integer

Data usage threshold for subscriber notification

Example:

10

​
ThrottleValue
integer

Data usage threshold for speed throttling

Example:

15

​
ThrottleSpeed
enum<string>

Throttled speed limit

Available options:
1-mbps,
5-mbps,
20-mbps,
50-mbps,
100-mbps
Example:

"1-mbps"

Response

200 - application/json

Data Usage Limit Set

The response is of type object.