# 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.

## Properties

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `object` | string | Yes | Type of object is always `subscriptionAddon`. |
| `id` | string | Yes | Unique identifier for the subscription add-on. |
| `activatedAt` | string,null | Yes | Time when the subscription add-on was activated. |
| `addon` | object | Yes | The add-on associated to the subscription add-on. |
| `billing` | object,null | Yes | Billing details for the subscription add-on. Present when the add-on has billing settings. |
| `canceledAt` | string,null | Yes | Time when the subscription add-on was canceled. |
| `createdAt` | string | Yes | Time when the subscription add-on was created. |
| `currentPeriod` | mixed | Yes | 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. |
| `endedAt` | string,null | Yes | 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  |
| `status` | pending | initiated | active | ended | Yes | 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.  |
| `subscription` | string | Yes | Unique identifier of the subscription the add-on applies to. |
| `user` | string | Yes | Unique identifier of the user the subscription add-on belongs to. |
