Skip to main content
API docs by Redocly

Billing APIs (2.0)

Download OpenAPI specification:Download

URL: https://docs.equinix.com/api-support.htm Terms of Service

The Billing API allows users to view summarized and detailed versions of invoices and credit memos. Users can filter the responses based on date range, account numbers, and transaction IDs. The user's permission is applied to retrieve the invoice summary, and invoice details will be from the past 12 months.

Billing Invoices

Billing Invoices

Retrieve billing summary

This method retrieves a summary invoice or credit memo information based on date range, account number or transactions ID for a user with billing viewing permission.

Authorizations:
BearerAuth
query Parameters
startDate
string <date>
Example: startDate=2021-09-17

Start date of invoice in YYYY-MM-DD format

endDate
string <date>
Example: endDate=2021-10-17

End date of invoice in YYYY-MM-DD format

accountNumbers
Array of strings

List of accounts to be filtered

transactionIds
Array of strings

List of transactions to be filtered

offset
integer >= 0
Default: 0

Use offset to control the number of records to be skipped in the response.

limit
integer [ 1 .. 200 ]
Default: 10

Use limit to restrict the number of records in the response.

Responses

Response Schema: application/json
Array of objects (invoiceSummaryDetails)
Array
transactionId
string

Unique identifier for a specific transaction. A transaction type can be an INVOICE or CREDIT_MEMO.

businessLegalEntity
string

Name of the Equinix entity that issued billing document

object
transactionType
string
Enum: "INVOICE" "CREDIT_MEMO"

Billing Type

transactionDate
string <date>

Billing Date

billingPurchaseOrder
string

Purchase order reference for invoice. When there are more than 1 applicable purchase order reference, this field will display multiple instead of showing specific purchase order number.

billingCycle
string

The start date which billing is being triggered

object
paymentDueDate
string <date>

Date which payment is due for the invoice in YYYY-MM-DD format

paymentTerms
string

Invoice payment terms

currencyCode
string (Currency Code)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

ISO-4217 currency code

totalRecurringAmount
number

Total recurring charges.

totalNonRecurringAmount
number

Total non-recurring charges.

totalAmount
number

Total invoice charges. This includes recurring and non-recurring charges.

totalAdjustment
number

Total adjustment amount.

vatNumber
string

Customer VAT Registration number

object (paymentInstructions)
Array of objects (taxInfo)
Array of objects (priorAdjustmentInfo)
totalPriorAdjustmentAmount
number

Adjusted original total amount.

object (pagination_summary)

Pagination

offset
integer
limit
integer
total
integer
next
string
previous
string

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Retrieve billing details

This method retrieves detailed invoice or credit memo information based on date range, account number or transactions ID for a user with billing viewing permission.

Authorizations:
BearerAuth
query Parameters
startDate
string <date>
Example: startDate=2021-09-17

Start date of invoice in YYYY-MM-DD format

endDate
string <date>
Example: endDate=2021-10-17

End date of invoice in YYYY-MM-DD format

accountNumbers
Array of strings

List of accounts to be filtered

transactionIds
Array of strings

List of transactions to be filtered

offset
integer >= 0
Default: 0

Use offset to control the number of records to be skipped in the response.

limit
integer [ 1 .. 200 ]
Default: 10

Use limit to restrict the number of records in the response.

Responses

Response Schema: application/json
Array of objects (invoiceItems)
Array
transactionId
string

Unique identifier for a specific transaction. A transaction type can be an INVOICE or CREDIT_MEMO.

businessLegalEntity
string

Name of the Equinix entity that issued billing document

region
string
Enum: "APAC" "AMER" "EMEA"

Region of the Equinix legal entity

countryCode
string

Country code of the Equinix legal entity. This is not to be confused with the customer legal entity’s countryCode

transactionType
string
Enum: "CREDIT_MEMO" "INVOICE"

Type of transaction. Can be of CREDIT_MEMO or INVOICE

transactionDate
string <date> (transactionDate)

Date of transaction in YYYY-MM-DD format

orderId
string

Unique identifier of the order

channel
string
Enum: "API" "PORTAL" "MOBILE" "OFFLINE" "OTHER"

Type of channel used to place the order

subChannel
string
Enum: "QUOTE" "IX" "ECX" "ECP" "CSC" "NRC_CHARGE_UPLOAD"

Type of sub-channel used to place the order

lineNumber
string

Line number for line item.

subLineNumber
string

Sub-line number for line item.

object
purchaseOrderNumber
string

Purchase order number

billingAgreementId
string

Billing Agreement Number.

customerReferenceId
string

Customer Reference Identifier / External Reference Identifier

priorAdjustmentReference
string

Prior Adjustment Invoice Id or Credit Memo Id

ibxs
Array of strings

Equinix datacenter location code

recurringStartDate
string <date>

This refers to the start date of totalRecurringAmount in YYYY-MM-DD format

recurringEndDate
string <date>

This refers to the end date of totalRecurringAmount in YYYY-MM-DD format

Array of objects
orderBookedDate
string <date>
activityType
string
Enum: "CREDIT_MRC" "CREDIT_NRC" "ONE_TIME_CHARGE" "RECURRING_CHARGE" "PRIOR_RECURRING_CHARGE" "ADJUSTMENT_CHARGE" "DEINSTALL"
productCategory
string

Name of product category.

productDescription
string

Description of the product.

productCode
string

Product catalog code.

productName
string

Product name.

detailedDescription
string
ibxDescription
string
quantity
number

The total amount of quantity bought. To be used with unitOfMeasure

unitOfMeasure
string

Metric of quantity

unitPrice
number

The unit price of product / service

frequency
string
Enum: "MONTHLY" "QUARTERLY" "YEARLY"

The period of recurring charges

currencyCode
string (Currency Code)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

ISO-4217 currency code

localCurrencyCode
string (Currency Code)
Enum: "AED" "AFN" "ALL" "AMD" "ANG" "AOA" "ARS" "AUD" "AWG" "AZN" "BAM" "BBD" "BDT" "BGN" "BHD" "BIF" "BMD" "BND" "BOB" "BOV" "BRL" "BSD" "BTN" "BWP" "BYN" "BZD" "CAD" "CDF" "CHE" "CHF" "CHW" "CLF" "CLP" "CNY" "COP" "COU" "CRC" "CUC" "CUP" "CVE" "CZK" "DJF" "DKK" "DOP" "DZD" "EGP" "ERN" "ETB" "EUR" "FJD" "FKP" "GBP" "GEL" "GHS" "GIP" "GMD" "GNF" "GTQ" "GYD" "HKD" "HNL" "HRK" "HTG" "HUF" "IDR" "ILS" "INR" "IQD" "IRR" "ISK" "JMD" "JOD" "JPY" "KES" "KGS" "KHR" "KMF" "KPW" "KRW" "KWD" "KYD" "KZT" "LAK" "LBP" "LKR" "LRD" "LSL" "LYD" "MAD" "MDL" "MGA" "MKD" "MMK" "MNT" "MOP" "MRU" "MUR" "MVR" "MWK" "MXN" "MXV" "MYR" "MZN" "NAD" "NGN" "NIO" "NOK" "NPR" "NZD" "OMR" "PAB" "PEN" "PGK" "PHP" "PKR" "PLN" "PYG" "QAR" "RON" "RSD" "RUB" "RWF" "SAR" "SBD" "SCR" "SDG" "SEK" "SGD" "SHP" "SLL" "SOS" "SRD" "SSP" "STN" "SVC" "SYP" "SZL" "THB" "TJS" "TMT" "TND" "TOP" "TRY" "TTD" "TWD" "TZS" "UAH" "UGX" "USD" "USN" "UYI" "UYU" "UYW" "UZS" "VES" "VND" "VUV" "WST" "XAF" "XAG" "XAU" "XBA" "XBB" "XBC" "XBD" "XCD" "XDR" "XOF" "XPD" "XPF" "XPT" "XSU" "XTS" "XUA" "XXX" "YER" "ZAR" "ZMW" "ZWL"

ISO-4217 currency code

exchangeRate
number

The exchange rate used in computing charges when local currency is different from invoice currency.

nonRecurringAmount
number

Amount of non-recurring charges.

recurringAmount
number

Amount of recurring charges.

adjustment
number

Amount of discounts or adjustments applied

taxAmount
number

Amount of tax applied

totalAmount
number

Net total amount after applicable taxes and discounts.

legacyOrderId
string

Order ID that were previously used in legacy orders

Array of objects (Additional Details of the product)
Array of objects (Terms of use)
object (pagination)

Paginations

offset
integer
limit
integer
total
integer
next
string
previous
string

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}