SubscriptionAddon

Subscription add-ons are features or top-ups that extend the functionality offered to the end user through their subscription, as defined by the associated add-on.

Name
object
Type
string
Description
Type of object is always subscriptionAddon.
Allowed values: subscriptionAddon
Name
id
Type
string
Description
Unique identifier for the subscription add-on.
Example: "sad_0SNlurA049MEWV2UNWPbDfW5B40U"
Name
activatedAt
Type
nullable string
Description
Time when the subscription add-on was activated.
Example: "2021-01-15T12:36:57Z"
Name
addon
Type
Add-on
Description
The add-on associated to the subscription add-on.
Name
billing
Type
nullable object
Description
Billing details for the subscription add-on. Present when the add-on has billing settings.
Name
discount
Type
nullable object
Description
Discount currently applied to the subscription add-on. A discount created from a voucher with the once recurrence type is used up by the first invoice it applies to, and is null afterwards. This includes the response to the request that applied it and events published later.
Name
canceledAt
Type
nullable string
Description
Time when the subscription add-on was canceled.
Example: "2021-01-22T19:39:53Z"
Name
createdAt
Type
string
Description
Time when the subscription add-on was created.
Example: "2021-01-15T12:30:28Z"
Name
currentPeriod
Type
nullable Period
Description
Current subscription add-on period. The value is null unless the subscription add-on is active. For a recurring add-on, number counts from 1 to the add-on's validity.totalPeriods, and each period lasts one validity period of the add-on, the first one starting when the subscription add-on was activated.
Name
number
Type
integer
Description
Sequence number of the period.
Optional: This property may not always be included.
Example: 1
>= 1
Name
start
Type
string
Description
Beginning of the period.
Optional: This property may not always be included.
Example: "2021-01-21T19:32:13Z"
Name
end
Type
string
Description
End of the period.
Optional: This property may not always be included.
Example: "2021-02-20T19:38:34Z"
Name
endedAt
Type
nullable string
Description
Time when the subscription add-on will end or has ended. This field is populated in different scenarios:

For an active recurring add-on, this represents the future date when its last period ends. It is set shortly after activation

When a subscription add-on has ended, this represents the past date when it ended

Otherwise, this field is null
Example: "2021-01-30T23:12:28Z"
Name
status
Type
string
Description
The current status of the subscription add-on.

initiated: Created, but waiting on a prerequisite (typically an unpaid invoice) before it can be activated.

pending: Cleared to activate and awaiting provisioning on the network provider.

active: Provisioned and usable.

ended: Terminated, for example when its allowance is used up, its validity elapses, or it is removed.
Allowed values: pending initiated active ended
Name
subscription
Type
string
Description
Unique identifier of the subscription the add-on applies to.
Example: "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
Name
user
Type
string
Description
Unique identifier of the user the subscription add-on belongs to.
Example: "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"

SubscriptionAddon object

{
  "object": "subscriptionAddon",
  "id": "sad_0SNlurA049MEWV2UNWPbDfW5B40U",
  "activatedAt": "2021-01-15T12:36:57Z",
  "addon": {
    "object": "addon",
    "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
    "metadata": {},
    "activationTrigger": "creation",
    "allowances": {
      "dataBytes": 10000000000,
      "voiceSeconds": 30000,
      "smsMessages": 100
    },
    "coverage": {
      "object": "coverage",
      "id": "de",
      "countries": {
        "0": "DE",
        "1": "FR",
        "2": "US"
      },
      "name": "Europe"
    },
    "createdAt": "2021-01-21T19:12:28.0Z",
    "description": "Disable international roaming.",
    "limits": {
      "dataBytes": 13000000000,
      "throttling": {
        "thresholdBytes": 3000000000,
        "bandwidthBitsPerSecond": 256000
      }
    },
    "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,
      "totalPeriods": 1
    },
    "data": 10000000000,
    "dataUnit": "byte",
    "sms": 100,
    "smsUnit": "message",
    "voice": 30000,
    "voiceUnit": "second"
  },
  "billing": {
    "discount": {
      "voucher": "vou_0SNlurA049MEWV0h2jfjkdiOdplN",
      "expiresAt": "2021-02-20T19:38:34Z"
    }
  },
  "canceledAt": "2021-01-22T19:39:53Z",
  "createdAt": "2021-01-15T12:30:28.0Z",
  "currentPeriod": {
    "number": 1,
    "start": "2021-01-21T19:32:13.0Z",
    "end": "2021-02-20T19:38:34.0Z"
  },
  "endedAt": "2021-01-30T23:12:28Z",
  "status": "pending",
  "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
  "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
}