# SubscriptionChange

Any change to a user’s subscription, such as swapping a SIM, or upgrading or downgrading a subscription.

## Properties

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `object` | string | Yes | Type of object is always `subscriptionChange`. |
| `id` | string | Yes | Unique identifier for the subscription change. |
| `appliedAt` | string,null | Yes | Time when the subscription change was applied. |
| `createdAt` | string | Yes | Time when the subscription change was created. |
| `failureCode` | string,null | Yes | An error code indicating the reason for a failed subscription change. |
| `plan` | mixed | Yes | The plan to which the subscription should be changed. |
| `requestedChange` | object | Yes | Object with the requested changes. |
| `scheduledAt` | string,null | Yes | Approximate time when the change should take place. This is typically set for changes scheduled at renewal. For changes that take effect immediately (when `requestedChange.when` is `"now"`), this may be null. |
| `sim` | mixed | Yes | The SIM to which the subscription should be changed. |
| `status` | pending | initiated | applied | failed | deleted | Yes | The current status of the subscription change. Note that the `initiated` status is currently only available when using the Billing API, where it implies that the subscription change invoice has not yet been paid.  |
| `subscription` | string,null | Yes | Unique identifier of the subscription to be changed. |