Skip to main content

Effective 10 September 2024, API Documentation can be found on our Equinix Product Documentation site.
The content on this page will not be updated after 1 Oct 2024 and will be inaccessible after 31st Dec 2024.


Billing Notifications

Billing Notifications are near real-time notifications triggered when the customer order is closed and billing is started by Equinix. These notifications will be triggered for all customers orders submitted through both offline and online channels.

Resellers will also receive billing notifications from EMG when billing starts for orders placed by customers.

Watch the video below to know how to receive Billing Notifications.



Sample Billing Notifications

{
"Task": {
"Id": "la83ef18-5e36-4a2d-9d80-490ee217d004",
"Source": "3e095d30-40ff-11e9-8959-5be078353003",
"Verb": "Update",
"Resource": "CrossConnnect",
"ContentType": "application/json",
"CreationTimeUTC": "2021-06-16T19:57:21.326Z",
"Version": "1.0",
"Body": {
"RequestorId": "",
"ServicerId": "1-205346710865",
"State": "Closed",
"Description": "Order Number:1-205346710865 billing notification",
"LineDetails": [
{
"Id": "1-3N5W5LYZ",
"Ibx": "DC1",
"Status": "Billed",
"BilledLines": [
"1-2N5W4JAS",
"1-2N5W4K87",
"1-2N5W3M21",
"1-2N5235N2"
]
}
]
}
},
"Signature": "RWNobwp7CiAgIklkIjogIjM1MGFlZjcwLTc4MWItMTFlOSogIH0KfQ=="
}

The description of the datacenter notification schema is as follows:

NameTypeApplicable Value(s)Description
TaskObjectThe task object comprises a common set of header attributes and a unique set of body attributes. The header attributes are applicable to all order types, whereas the body attributes vary for each order.
IDString (Guid)The unique identifier of the message. Equinix will send a unique value for each message.
SourceString (Guid)A unique value to identify the message sender. This value will be shared with the customer during the onboarding process.
VerbStringUpdateThis indicates there is an update from Equinix.
ResourceStringEquinix Product Name for which the notification is being sent.
ContentTypeStringapplication/json
CreateTimeUTCStringIndicates the date and time at which the notification is sent by Equinix.
VersionString1.0The version of the notification schema.
BodyObjectAn object containing the details of the notification. The attributes within the object will vary based on the resource and verb.
RequestorIdStringCustomer reference number for the maintenance (if any)
ServicerIdStringIndicates the unique id supplied by Equinix for the submitted order.
StateStringClosed

Indicates the current state of Order.

Supported Value - 'Closed'
DescriptionObjectSummary of the ticket from Billing System
LineDetailsArray

An array of object containing the details of the Billed Line Items and Datacenter information with the below attributes

  • Id  : Unique Billing Line ID
  • Ibx : Name of the DataCenter/IBX
  • Status : Supprted value "Billed"
  • BilledLines  :  Array of Billed Line Items as of type "String"
SignatureStringBase64 encoded signature signed with Equinix key