Add-on

Name
object
Type
string
Description
Type of object is always addon.
Allowed values: addon
Name
id
Type
string
Description
Unique identifier for the add-on.
Example: "add_0SNlurA049MEWV4VxLfwJc7PJtHc"
Name
activationTrigger
Type
string
Description
Indicates when a subscription add-on will take effect.

creation: As soon as it is created. The user does not need to take any further action.

networkLatch: When the user's data session ends, which can be forced by power cycling the device.
Example: "creation"
Allowed values: creation networkLatch
Name
allowances
Type
object
Description
The allowances included in the add-on.
Name
dataBytes
Type
nullable integer
Description
The data allowance in bytes. A value of null indicates unlimited data.
Example: 10000000000
Name
voiceSeconds
Type
nullable integer
Description
The voice call allowance in seconds. A value of null indicates unlimited calls.
Example: 30000
Name
smsMessages
Type
nullable integer
Description
The SMS allowance in messages. A value of null indicates unlimited SMS.
Example: 100
Name
createdAt
Type
string
Description
Time when the add-on was created .
Example: "2021-01-21T19:12:28Z"
Name
description
Type
nullable string
Description
The description of the add-on.
Example: "Disable international roaming."
Name
name
Type
string
Description
Name for the add-on.
Example: "1GB Data Top-up"
Name
plans
Type
array
Description
The plans this add-on is compatible with.
Name
price
Type
object
Description
The price of the add-on.
Name
amount
Type
integer
Description
The price amount in the currency's minor unit, e.g. "cents" for many currencies.
Example: 999
>= 0
Name
currency
Type
string
Description
Three-letter ISO 4217 currency code. Must be a supported currency.
Example: "USD"
Name
provider
Type
string
Description
The ID of the network provider supported by this add-on.
Example: "p5"
Name
recurrenceType
Type
string
Description
The recurrence type the add-on.
Example: "oneTime"
Allowed values: oneTime recurring
Name
status
Type
string
Description
The current status of the add-on.
Allowed values: draft available archived
Name
type
Type
string
Description
The type of the add-on.
Example: "topUp"
Allowed values: topUp other
Name
validity
Type
nullable object
Description
The optional validity of the add-on. Add-ons without a set validity will inherit the validity of the subscribed plan.
Name
unit
Type
string
Description
The time unit of the add-on, either day or month.
Allowed values: day month
Name
value
Type
integer
Description
The amount of units (specified in the unit property).
Example: 7
>= 1

Example

{
  "object": "addon",
  "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
  "activationTrigger": "creation",
  "allowances": {
    "dataBytes": 10000000000,
    "voiceSeconds": 30000,
    "smsMessages": 100
  },
  "createdAt": "2021-01-21T19:12:28.0Z",
  "description": "Disable international roaming.",
  "name": "1GB Data Top-up",
  "plans": [
    "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
  ],
  "price": {
    "amount": 999,
    "currency": "USD"
  },
  "provider": "p5",
  "recurrenceType": "oneTime",
  "status": "draft",
  "type": "topUp",
  "validity": {
    "unit": "day",
    "value": 7
  },
  "data": 10000000000,
  "dataUnit": "byte",
  "sms": 100,
  "smsUnit": "message",
  "voice": 30000,
  "voiceUnit": "second"
}