Billing API | Equinix Product Documentation

Accounts

Operations

Get billing accounts summary

Request

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

Query

offsetinteger, >= 0

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

Default:0

limitinteger, [ 0 .. 100 ]

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

Default:10

sortsstring

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 '-'

Default:"ACCOUNT_NUMBER"

Enum:"ACCOUNT_NUMBER""-ACCOUNT_NUMBER""PARENT_ACCOUNT_NUMBER""-PARENT_ACCOUNT_NUMBER""ACCOUNT_NAME""-ACCOUNT_NAME"

Authorizationstringrequired

Specify the Access token with prefix 'Bearer '.

Payload

// No request payload

Responses

Bodyapplication/json

dataArray of objects(Account)required

List accounts with billing summary

Example:

[
  {
    "accountName": "Example Inc.",
    "accountNumber": "124353",
    "parentAccountNumber": "54321",
    "accountIbxs": [ … ]
  }
]

pageobject(Page)

Example:

{
  "total": 5469,
  "limit": 50,
  "offset": 15,
  "sorts": [
    "cupidatat",
    "dolor occaecat"
  ]
}

_linksobject(Links)required

Example:

{
  "prev": {
    "href": "/accounts?limit=10&offset=50"
  },
  "self": {
    "href": "/accounts?limit=10&offset=40"
  },
  "next": {
    "href": "/accounts?limit=10&offset=30"
  }
}

Response

{
  "data": [
    { … }
  ],
  "page": {
    "total": 1200,
    "limit": 20,
    "offset": 0
  },
  "_links": {
    "prev": { … },
    "self": { … },
    "next": { … }
  }
}

Accounts

Get billing accounts summary

Request

Query

Headers

Responses