Skip to main content
API docs by Redocly

Billing API (1.0.0)

Download OpenAPI specification:Download

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

Based on a user's permission, a User can view financial records and payment history and download invoice documents for their permitted billing accounts. The invoice and payment document can be filtered by product type, account, or date range. Only the account billing and invoice details will be from the past 12 months will be returned.

Accounts

Get billing accounts summary

This method returns a summary of all the billing accounts that the user has permissions to view.

query Parameters
offset
integer >= 0
Default: 0

Use offset and limit to restrict the number of users in the output. Offset can be used to specify the start record

limit
integer [ 0 .. 100 ]
Default: 10

Use offset and limit to restrict the number of users in the output. Limit can be used to restrict the number of reports in the response

sorts
string
Default: "ACCOUNT_NUMBER"
Enum: "ACCOUNT_NUMBER" "-ACCOUNT_NUMBER" "PARENT_ACCOUNT_NUMBER" "-PARENT_ACCOUNT_NUMBER" "ACCOUNT_NAME" "-ACCOUNT_NAME"

Use sorts to get the accounts in the response sorted in the particular order. for example, use '-ACCOUNT_NUMBER' to sort the reports by generated date in descending order. And 'ACCOUNT_NUMBER' for ascending order. For descending order, the field name should be prefixed with '-'

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json
required
Array of objects (Account)

List accounts with billing summary

Array
accountNumber
string
parentAccountNumber
string
accountName
string
billingFrequency
string
Enum: "MONTHLY" "QUARTERLY" "ANNUALLY"

Frequency of billing

currencyCode
string non-empty

Currency code of the account

invoiceLanguage
string

Language of the invoice

invoiceFormat
string
Enum: "PDF" "EXCEL"

Format of the invoice

Array of objects (Invoice)

Available invoices for the account

Array of objects (Payment)

Available payments for the account

object (BillingContact)
accountIbxs
Array of strings
object (Page)
total
required
integer >= 0
Default: 0

Total number of records

limit
required
integer >= 0
Default: 0

Number of records per page

offset
required
integer >= 0
Default: 0

The page number

sorts
Array of strings

Sort fields based on polarity

required
object (Links)
object (ReferenceLink)
href
required
string non-empty

href of the link

required
object (ReferenceLink)
href
required
string non-empty

href of the link

object (ReferenceLink)
href
required
string non-empty

href of the link

Response samples

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

Download specific invoice document

This method billing document from an account by its specific invoice identifier and document identifier

path Parameters
accountNumber
required
string

Account number

invoiceId
required
string

Invoice Id

query Parameters
documentId
required
string non-empty

Document Id

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/octet-stream
string <binary>

Get specific billing account summary

This method returns a billing summary of an account based on the account number given.

path Parameters
accountNumber
required
string

Account number

query Parameters
months
Array of strings
Default: ""

Finance documents will be pulled for these months ex: 2017-12-03,2018-01-03 in ISO_LOCAL_DATE format

header Parameters
Authorization
required
string

Specify the Access token with prefix 'Bearer '.

Responses

Response Schema: application/json
accountNumber
string
parentAccountNumber
string
accountName
string
billingFrequency
string
Enum: "MONTHLY" "QUARTERLY" "ANNUALLY"

Frequency of billing

currencyCode
string non-empty

Currency code of the account

invoiceLanguage
string

Language of the invoice

invoiceFormat
string
Enum: "PDF" "EXCEL"

Format of the invoice

Array of objects (Invoice)

Available invoices for the account

Array
invoiceId
required
string non-empty

Identifier for the invoice

transactionNumber
string non-empty

Tansaction number of the invoice

amount
required
number <double>

Total amount of the invoice

date
required
string <date>

Date of the invoice

type
string (InvoiceType)
Enum: "INVOICE" "MANUAL_INVOICE" "CREDIT_MEMO" "STATEMENT"

Type of the invoice

Array of objects (InvoiceDocument)

Array of invoice documents

Array of objects (Payment)

Available payments for the account

Array
paymentId
required
string non-empty

Identifier for the payment, payment receipt number

date
required
string <date>

Payment created date

status
required
string
Enum: "APPLIED" "UNAPPLIED"

Status of the payment

amount
required
number <double>

Amount of the payment

object (BillingContact)
firstName
required
string

First name

lastName
required
string

Last name

email
required
string <email>

Email address

accountIbxs
Array of strings

Response samples

Content type
application/json
{
  • "accountNumber": "124353",
  • "billingContact": {
    },
  • "billingFrequency": "MONTHLY",
  • "invoiceLanguage": "English",
  • "invoiceFormat": "PDF",
  • "invoices": [
    ],
  • "currencyCode": "GBP",
  • "payments": [
    ]
}