# VirtualNumber

Virtual numbers are additional numbers that can be added for a user. Any calls made or texts sent to an active virtual number will be received by the primary number of the `subscription`. Note that this is an experimental feature that is only available in select projects.

<!-- theme: info -->
> #### Preview
>
> This schema is currently in preview and might change in the future.
>
> We’re excited to hear your feedback and ideas. Please send an email
> to [support@gigs.com](mailto:support@gigs.com) to share your thoughts.

## Properties

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `object` | string | Yes | Type of object is always `virtualNumber`. |
| `id` | string | Yes | Unique identifier for the virtual number. |
| `activatedAt` | string,null | Yes | Time when the virtual number was activated. |
| `canceledAt` | string,null | Yes | Time when the virtual number was canceled. |
| `createdAt` | string | Yes | Time when the virtual number was created. |
| `endedAt` | string,null | Yes | Time when the virtual number will end or has ended. This field is populated in different scenarios: - When a virtual number is canceled, this represents the future date when it will be terminated - When a virtual number has already ended, this represents the past date when it was terminated  |
| `phoneNumber` | string,null | Yes | The virtual phone number. |
| `status` | active | ended | initiated | processing | Yes | The current status of the virtual number. |
| `subscription` | string | Yes | Unique identifier for the subscription this virtual number belongs to. |
| `user` | string | Yes | Unique identifier for the user this virtual number belongs to. |