Platform Billing Account APIs | Equinix Product Documentation

Billing Account

Billing Account related APIs

Operations

Get customer's billing accounts

Request

Get customer's billing accounts

Security

bearerAuth

Bodyapplication/json

ibxCodestring

IBX where billing account can place order.

Example:"SV1"

metroCodestring

Metro where billing account can place order.

Example:"SV"

accountStatusArray of strings

List of account status to search.

Example:

[
  "ACTIVE"
]

projectIdstring

Project id where billing account associated with.

Example:"10d8f2af-07f5-4276-9569-2aa46425713c"

limitinteger, [ 1 .. 100 ]

Specifies the page size.

Default:100

Example:100

offsetinteger, >= 0

Specifies where to start a page. It is the starting point of the collection returned from the server.

Default:0

Example:0

Payload

{
  "ibxCode": "SV1",
  "metroCode": "SV",
  "accountStatus": [
    "ACTIVE"
  ],
  "projectId": "10d8f2af-07f5-4276-9569-2aa46425713c",
  "limit": 100,
  "offset": 0
}

Responses

Search result of billing account

Bodyapplication/json

paginationobject

Pagination info

dataArray of objects(BillingAccount)

Search result

Response

{
  "pagination": {
    "offset": 0,
    "limit": 100,
    "total": 1
  },
  "data": [
    { … }
  ]
}