# PortOut

Port out is required when a user wants to keep their number when cancelling their subscription. There are multiple steps involved between the user, the current carrier, and the new carrier.

## Properties

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `object` | string | Yes | Type of object is always `portOut`. |
| `id` | string | Yes | Unique identifier for the port out. |
| `behavior` | cancelOnly | portOut | Yes | The behavior of the port out.  A value of `portOut` indicates that using this port out will transfer the phone number to the recipient provider.  Port out with behavior `cancelOnly` will cancel the service without transferring the number. This behavior is currently only available for local plans in the United Kingdom.  |
| `completedAt` | string,null | Yes | Time when the port out is completed successfully. |
| `createdAt` | string | Yes | Time when the port out was created. |
| `expiredAt` | string,null | Yes | Time when the port out expires and won't be valid anymore. |
| `failureReason` | null | consentNotGiven | consentRequestCanceled | Yes | The reason for the port out failure. |
| `status` | completed | expired | failed | initiated | issued | processing | Yes | The current status of the port out. |
| `subscription` | string | Yes | Unique identifier of the subscription affected. |
| `user` | string | Yes | Unique identifier for the user this port out credentials are for. |