# Order Object

Order Object attributes.

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| reference | `string` | Order Reference number. |
| amount | `string` | Total order amount. |
| status | `enum` | Status of the Order.   Possible values:   `pending`   `completed`   `canceled` |
| description | `string` | Description of the Order. |
| external\_reference\_id | `string` | Optional identifier for the order in the customer's external system. Maximum length is 100 characters. |
| created\_at | `DateTime` | Date and time of Order creation. |
| items | `Array<OrderItem>` | Ordered items array. |
| callback\_url | `string` | The HTTP or HTTPS endpoint to where events related to order will be delivered. |
| callback\_method | `string` | The HTTP Method used for order events. `post` and `get` are supported methods. Can be `null` for orders created by the Emergency Calling activation flow. |

### Order Item

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| type | `string` | No | Item object type: `did_order_items` for DIDs, `capacity_order_items` for channels, or `emergency_order_items` for Emergency Calling charges. In earlier API versions, emergency charges may be returned as `generic_order_items` for backward compatibility. |
| attributes | One of [DID Order Item Attributes](#did-order-item-attributes-v34),   [Capacity Order Item Attributes](#capacity-order-item-attributes-v34),   [Emergency Order Item Attributes](#emergency-order-item-attributes-v34) | No | Order Item Attributes object. |

### Order Item Attributes

DIDCapacityEmergency

| Name | Type | Description |
| --- | --- | --- |
| qty | `integer` | Quantity of services. |
| nrc | `string` | One-time activation fee (Non Recurring Cost). |
| mrc | `string` | Ongoing monthly fees (Monthly Recurring Cost). |
| prorated\_mrc | `boolean` | If true, MRC will be charged prorated amount for the services acquired in the middle of the billing cycle.   If false, MRC will be charged full amount for the full billing cycle. |
| billed\_from | `date` | Billing cycle start date. |
| billed\_to | `date` | Billing cycle end date. |
| did\_group\_id | `string` | DID Group ID. |

| Name | Type | Description |
| --- | --- | --- |
| qty | `integer` | Quantity of services. |
| nrc | `string` | One-time activation fee (Non Recurring Cost). |
| mrc | `string` | Ongoing monthly fees (Monthly Recurring Cost). |
| prorated\_mrc | `boolean` | If true, MRC will be charged prorated amount for the services acquired in the middle of the billing cycle.   If false, MRC will be charged full amount for the full billing cycle. |
| billed\_from | `date` | Billing cycle start date. |
| billed\_to | `date` | Billing cycle end date. |
| capacity\_pool\_id | `string` | Capacity Pool ID. |

| Name | Type | Description |
| --- | --- | --- |
| qty | `integer` | Quantity of services. |
| nrc | `string` | One-time activation fee (Non Recurring Cost). |
| mrc | `string` | Ongoing monthly fees (Monthly Recurring Cost). |
| prorated\_mrc | `boolean` | If true, MRC is charged as a prorated amount for services acquired in the middle of the billing cycle. If false, MRC is charged in full for the billing cycle. |
| billed\_from | `date` | Billing cycle start date. |
| billed\_to | `date` | Billing cycle end date. |
| emergency\_calling\_service\_id | `string` | Emergency Calling Service ID associated with the order item. |

On this page