Allowance

An allowance represents a specific usage limit (e.g., minutes, bytes, messages) the purchase of a product entitles a user to.

Name
object
Type
string
Description
Type of object is always allowance.
Allowed values: allowance
Name
name
Type
string
Description
The human-readable name of this allowance.
Example: "Long distance calls while roaming in Germany"
Name
type
Type
string
Description
The type of usage permitted by this allowance.
Allowed values: data voice sms
Name
coverage
Type
Coverage
Description
The geographic coverage of the allowance.
Name
limit
Type
nullable integer
Description
The amount of usage permitted by this allowance counted in unit. A value of null indicates an unlimited allowance.
Example: 500
Name
unit
Type
string
Description
The unit the usage permitted by this allowance is counted in.
Allowed values: bytes seconds messages

Example

{
  "object": "allowance",
  "name": "Long distance calls while roaming in Germany",
  "type": "data",
  "coverage": {
    "object": "coverage",
    "id": "de",
    "countries": [
      "DE",
      "FR",
      "US"
    ],
    "name": "Europe"
  },
  "limit": 500,
  "unit": "bytes"
}