Accounts

Get Accounts

	GET /internetAccess/v1/accounts
Method	GET
Endpoint	/internetAccess/v1/accounts
Headers	Authorization
Path Parameters	Not applicable
Query Parameters	operationalUnits.ibxs.ibx, offset, limit
Body Parameters	Not applicable

This API request retrieves all accounts that are available for Equinix Internet Access ordering in a given IBX data center.

Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/accounts?operationalUnits.ibxs.ibx=DC5&offset=0&limit=50'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter	Description
operationalUnits.ibxs.ibx string REQUIRED	IBX data center identifier. Applicable values: Use the Get IBX Data Centers API request to retrieve IBX data centers where Equinix Internet Access is available. Example: DC5
project.projectId string REQUIRED	Project identifier in customer resource hierarchy. Applicable values: Use the Get Projects API request to retrieve all projects in the root organization. Example: 1234
offset integer OPTIONAL	Index of the first item returned in the response. Default value: 0
limit integer OPTIONAL	Maximum number of items returned per page. Default value: 50

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 20,
        "total": 1
    },
    "data": [
        {
            "accountNumber": "123456",
            "accountName": "John Doe",
            "billing": {
                "signatureRequired": false,
                "poExempted": true,
                "poBearing": true,
                "currency": "USD"
            },
            "operationalUnits": [
                {
                    "ibxs": [
                        {
                            "ibx": "DC5"
                        }
                    ],
                    "metros": [
                        {
                            "metroCode": "DC"
                        }
                    ]
                }
            ],
            "orgId": "1232",
            "organizationName": "Equinix, Inc."
        }
    ]
}

Response payload body description

Parameter	Description
pagination object	Data set pagination information.
offset integer	Index of the first item returned in the response.
limit integer	Maximum number of items returned per page.
total integer	Total number of items.
data array[object]	Data set containing billing account information.
accountNumber string	Customer account number. Example: 100013200
accountName string	Name of customer account. Example: Web Henderson
billing object	Account billing information.
signatureRequired boolean	Indicates if the signature is required. Example: false
poExempted boolean	Indicates if the purchase order has been exempted. Example: false
poBearing boolean	Indicates if the purchase order is required. Example: false
currency boolean	Billing account currency. Example: USD
operationalUnits array[object]	Objects array containing information on legal entities that operate the given IBX data center.
ibxs array[objects]	List of IBX data centers.
ibx string	IBX data center identifier. Example: DC5
metros array[objects]	List of metros.
metroCode string	Metropolitan area identifier. Example: DC
orgId string	Customer organization identifier. Example: 1234
organizationName string	Customer organization name. Example: Joe Average Inc.

Get Specified Account

	GET /internetAccess/v1/accounts/{accountNumber}
Method	GET
Endpoint	/internetAccess/v1/accounts/{accountNumber}
Headers	Authorization
Path Parameters	accountNumber
Query Parameters	Not applicable
Body Parameters	Not applicable

This API request retrieves specified account.

Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/accounts/123456'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
accountNumber string REQUIRED	Customer account number. Applicable values: Use the Get Accounts API request to retrieve accounts eligible for ordering Equinix Internet Access. Example: 123456

Sample response

{
    "accountNumber": "123456",
    "accountName": "John Doe",
    "billing": {
        "signatureRequired": false,
        "poExempted": true,
        "poBearing": true,
        "currency": "USD"
    },
    "operationalUnits": [
        {
            "ibxs": [
                {
                    "ibx": "DC5"
                }
            ],
            "metros": [
                {
                    "metroCode": "DC"
                }
            ]
        }
    ],
    "orgId": "1232",
    "organizationName": "Equinix, Inc."
}

Response payload body description

Parameter	Description
accountNumber string	Customer account number. Example: 100013200
accountName string	Customer account name. Example: Web Henderson
billing object	Account billing information.
signatureRequired boolean	Indicates if the signature is required. Example: false
poExempted boolean	Indicates if the purchase order has been exempted. Example: false
poBearing boolean	Indicates if the purchase order is required. Example: false
currency boolean	Billing account currency. Example: USD
operationalUnits array[object]	Objects array containing information on legal entities that operate the given IBX data center.
ibxs array[objects]	List of IBX data centers.
ibx string	IBX data center identifier. Example: WA1
metros array[objects]	List of metros.
metroCode string	Metropolitan area identifier. Example: WA
orgId string	Customer organization identifier.
organizationName string	Customer organization name.

Get Account Agreements

	GET /internetAccess/v1/accounts/{accountNumber}/agreements
Method	GET
Endpoint	/internetAccess/v1/accounts/{accountNumber}/agreements
Headers	Authorization
Path Parameters	accountNumber
Query Parameters	ibx, offset, limit
Body Parameters	Not applicable

This API request returns account agreements for a specified account number.

Sample curl request

curl -X GET 'https://api.equinix.com/internetAccess/v1/accounts/123456/agreements?ibx=DC5'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter	Description
accountNumber string REQUIRED	Customer account number. Example: 123456

Query parameters

Parameter	Description
ibx string REQUIRED	IBX data center identifier. Applicable values: Use the Get IBX Data Centers API request to retrieve IBX data centers where Equinix Internet Access is available. Example: DC5
offset integer OPTIONAL	Index of the first item returned in the response. Default value: 0
limit integer OPTIONAL	Maximum number of items returned per page. Default value: 50

Sample response

{
    "pagination": {
        "offset": 0,
        "limit": 50,
        "total": 1
    },
    "data": [
        {
            "ibx": "DC5",
            "type": "MCA_GTC",
            "valid": true
        }
    ]
}

Response payload body description

Parameter	Description
pagination object	Data set pagination information.
offset integer	Index of the first item returned in the response.
limit integer	Maximum number of items returned per page.
total integer	Total number of items returned.
next string	Next data page URL.
previous string	Previous data page URL.
data array[object]	Data set containing account agreements.
ibx string	IBX data center identifier. Example: WA1
type string	Agreement type. Possible values: MCA_GTC - Master Country Agreement, Global Terms & Conditions
valid boolean	Indicates if the account agreement is valid. Example: true