Skip to main content
API docs by Redocly

Platform Billing Account APIs (2.0.0)

Download OpenAPI specification:Download

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

API Documentation for BAS

Find more information on Equinix Developer Portal

Billing Account

Billing Account related APIs

Get customer's billing accounts

Get customer's billing accounts

Authorizations:
bearerAuth
Request Body schema: application/json
ibxCode
string

IBX where billing account can place order.

metroCode
string

Metro where billing account can place order.

accountStatus
Array of strings (AccountStatus)
Items Enum: "ACTIVE" "PENDING_SIGNATURE" "CREDIT_HOLD" "IN_PROGRESS" "DECLINED"

List of account status to search.

projectId
string

Project id where billing account associated with.

limit
integer [ 1 .. 100 ]
Default: 100

Specifies the page size.

offset
integer >= 0
Default: 0

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

Responses

Response Schema: application/json
object

Pagination info

offset
integer

It is the starting point of the collection returned fromt the server.

limit
integer

The page size.

total
integer

The total number of results.

Array of objects (BillingAccount)

Search result

Array
accountId
string

Billing account ID.

accountNumber
string

Billing account number.

accountName
string

Billing account name.

currency
string

Billing account currency.

billingCountry
string

Billing account country.

accountStatus
string (AccountStatus)
Enum: "ACTIVE" "PENDING_SIGNATURE" "CREDIT_HOLD" "IN_PROGRESS" "DECLINED"

Billing account status

isGlobal
boolean

Indicator for billing account type. true = Global billing account, false = Local billing account

isPoRequired
boolean

Indicator for pucharse order required.

isSignatureRequired
boolean

Indicator for signature required.

isReseller
boolean

Indicator for reseller.

isSubCustomer
boolean

Indicator for sub customer.

createdDatetime
string <date-time>

Billing Account created datetime

lastModifiedDatetime
string <date-time>

Billing account last modified datetime

Request samples

Content type
application/json
{
  • "ibxCode": "SV1",
  • "metroCode": "SV",
  • "accountStatus": [
    ],
  • "projectId": "10d8f2af-07f5-4276-9569-2aa46425713c",
  • "limit": 100,
  • "offset": 0
}

Response samples

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

Get billing account detail by account number

Get billing account detail by account number

Authorizations:
bearerAuth
path Parameters
accountNumber
required
string
Example: 12345

Billing account number

Responses

Response Schema: application/json
accountId
string

Billing account ID.

accountNumber
string

Billing account number.

accountName
string

Billing account name.

currency
string

Billing account currency.

billingCountry
string

Billing account country.

accountStatus
string (AccountStatus)
Enum: "ACTIVE" "PENDING_SIGNATURE" "CREDIT_HOLD" "IN_PROGRESS" "DECLINED"

Billing account status

isGlobal
boolean

Indicator for billing account type. true = Global billing account, false = Local billing account

isPoRequired
boolean

Indicator for pucharse order required.

isSignatureRequired
boolean

Indicator for signature required.

isReseller
boolean

Indicator for reseller.

isSubCustomer
boolean

Indicator for sub customer.

createdDatetime
string <date-time>

Billing Account created datetime

lastModifiedDatetime
string <date-time>

Billing account last modified datetime

Response samples

Content type
application/json
{
  • "accountId": "C-12345",
  • "accountNumber": "12345",
  • "accountName": "Equinix",
  • "currency": "USD",
  • "billingCountry": "US",
  • "accountStatus": "ACTIVE",
  • "isGlobal": true,
  • "isPoRequired": false,
  • "isSignatureRequired": false,
  • "isReseller": false,
  • "isSubCustomer": false,
  • "createdDatetime": "2020-05-21T10:30:00+00:00",
  • "lastModifiedDatetime": "2020-05-23T12:30:00+00:00"
}

Get Billing account detail by account id

Get billing account detail by account id

Authorizations:
bearerAuth
path Parameters
accountId
required
string
Example: C-12345

Billing Account Id

Responses

Response Schema: */*
accountId
string

Billing account ID.

accountNumber
string

Billing account number.

accountName
string

Billing account name.

currency
string

Billing account currency.

billingCountry
string

Billing account country.

accountStatus
string (AccountStatus)
Enum: "ACTIVE" "PENDING_SIGNATURE" "CREDIT_HOLD" "IN_PROGRESS" "DECLINED"

Billing account status

isGlobal
boolean

Indicator for billing account type. true = Global billing account, false = Local billing account

isPoRequired
boolean

Indicator for pucharse order required.

isSignatureRequired
boolean

Indicator for signature required.

isReseller
boolean

Indicator for reseller.

isSubCustomer
boolean

Indicator for sub customer.

createdDatetime
string <date-time>

Billing Account created datetime

lastModifiedDatetime
string <date-time>

Billing account last modified datetime

Response samples

Content type
application/json
[
  • {
    }
]