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, Capacity Order Item Attributes, Emergency Order Item Attributes	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.