Prices
Retrieve Pricing
POST /internetAccess/v1/prices/search | |
---|---|
Method | POST |
Endpoint | /internetAccess/v1/prices/search |
Headers | Authorization, Content-Type |
Path Parameters | Not applicable |
Query Parameters | offset, limit |
Body Parameters | filter, and, property, operator, values |
This API request retrieves pricing information for a specified Equinix Internet Access configuration. The
currency is determined by the billing account settings. If a product or its part is provided free of
charge, it's listed with the price
parameter value of 0.
The Pricing Information obtained using the Get Pricing API request: (1) is calculated pursuant to the Master Country Agreement, Pricing Agreement,&or other similar agreement (“Agreement”) effective between Equinix and Customer; and (2) does not include taxes and may vary depending upon the options selected by Customer in the Order and the applicable tax jurisdiction.
Sample curl request - Equinix Internet Access pricing
curl -X POST 'https://api.equinix.com/internetAccess/v1/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"INTERNET_ACCESS_PRODUCT"
]
},
{
"property": "/account/accountNumber",
"operator": "=",
"values": [
"123456"
]
},
{
"property": "/service/type",
"operator": "=",
"values": [
"SINGLE_PORT"
]
},
{
"property": "/service/useCase",
"operator": "=",
"values": [
"MAIN"
]
},
{
"property": "/service/billing",
"operator": "=",
"values": [
"FIXED"
]
},
{
"property": "/service/connection/type",
"operator": "=",
"values": [
"IA_C"
]
},
{
"property": "/service/connection/aSide/accessPoint/type",
"operator": "=",
"values": [
"COLO"
]
},
{
"property": "/service/connection/aSide/accessPoint/location/ibx",
"operator": "=",
"values": [
"DC5"
]
},
{
"property": "/service/connection/aSide/accessPoint/port/physicalPort/speed",
"operator": "=",
"values": [
10000
]
},
{
"property": "/service/connection/aSide/accessPoint/port/physicalPortQuantity",
"operator": "=",
"values": [
1
]
},
{
"property": "/service/routingProtocol/type",
"operator": "=",
"values": [
"BGP"
]
},
{
"property": "/service/routingProtocol/ipv4/customerRoute/ipBlock/prefixLength",
"operator": "=",
"values": [
28
]
},
{
"property": "/service/routingProtocol/ipv6/customerRoute/ipBlock/prefixLength",
"operator": "=",
"values": [
48
]
}
]
}
}'
Sample curl request - IP block pricing
curl -X POST 'https://api.equinix.com/internetAccess/v1/prices/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "=",
"values": [
"IP_BLOCK_PRODUCT"
]
},
{
"property": "/ipBlock/type",
"operator": "=",
"values": [
"IA_IP_BLOCK"
]
},
{
"property": "/account/accountNumber",
"operator": "=",
"values": [
"123456"
]
},
{
"property": "/ipBlock/location/ibx",
"operator": "=",
"values": [
"DC5"
]
},
{
"property": "/ipBlock/ipv4/prefixLength",
"operator": "=",
"values": [
28
]
}
]
}
}
Query parameters
Parameter
|
Description |
---|---|
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 |
Body parameters
Parameter
|
Description |
---|---|
filter object REQUIRED |
Object defining search conditions. |
and
array[object] REQUIRED |
Array of search parameters. |
property
string REQUIRED |
Search field parameter. Applicable values:
|
operator
string REQUIRED |
Search field parameter operator. Applicable values: = |
values
array[string/integer] REQUIRED |
Search field parameter value. Example: IA_IP_BLOCK |
/type | Product type. Example: "property": "/type", "operator": "=", "values": [ & & "INTERNET_ACCESS_PRODUCT" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Example:
|
/account/accountNumber | Billing account number. Example: "property": "/account/accountNumber", "operator": "=", "values": [ & & "123456" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Example: 123456 |
/service/type | Service port type option. Applicable to INTERNET_ACCESS_PRODUCT
product type.Example: "property": "/service/type", "operator": "=", "values": [ & & "DUAL_PORT" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values:
|
/service/useCase | Internet access use case. Applicable to INTERNET_ACCESS_PRODUCT
product type.Example: "property": "/service/useCase", "operator": "=", "values": [ & & "BACKUP" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values:
|
/service/bandwidth | Connection bandwidth in Mbps. Applicable to
INTERNET_ACCESS_PRODUCT product type, FIXED and
BURST_BASED billing.Example: "property": "/service/bandwidth", "operator": "=", "values": [ & & 1000 ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[integer] REQUIRED |
Search field parameter value. Example: 1000 |
/service/billing | Service billing type. Applicable to INTERNET_ACCESS_PRODUCT
product type.Example: "property": "/service/billing", "operator": "=", "values": [ & & "USAGE_BASED" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values:
|
/service/connection/type | Internet access connection type. Applicable to
INTERNET_ACCESS_PRODUCT product
type.Example: "property": "/service/connection/type", "operator": "=", "values": [ & & "IA_C" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values:
|
/service/connection/aSide/accessPoint/type | Connection endpoint type. Applicable to INTERNET_ACCESS_PRODUCT
product type.Example: "property": "/service/connection/aSide/accessPoint/type", "operator": "=", "values": [ & & "COLO" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values:
|
/service/connection/aSide/ accessPoint/location/ibx | IBX data center identifier. Applicable to INTERNET_ACCESS_PRODUCT
product type.Example: "property": "/service/connection/aSide/accessPoint/location/ibx", "operator": "=", "values": [ & & "WA1" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values: Use the Get IBX Data Centers API request to retrieve IBX data centers where Equinix Internet Access is available. |
/service/connection/aSide/ accessPoint/port/physicalPort/speed | Port bandwidth capacity. Applicable to INTERNET_ACCESS_PRODUCT
product type.Example: "property": "/service/connection/aSide/accessPoint/port/physicalPort/speed", "operator": "=", "values": [ & & 10000 ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[integer] REQUIRED |
Search field parameter value. Applicable values:
|
/service/connection/aSide/ accessPoint/port/physicalPortQuantity | Number of physical ports. Applicable to INTERNET_ACCESS_PRODUCT
product type.Example: "property": "/service/connection/aSide/accessPoint/port/physicalPortQuantity", "operator": "=", "values": [ & & 1 ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[integer] REQUIRED |
Search field parameter value. Minimum: 1 Maximum: 10 |
/service/routingProtocol/type | Routing protocol type. Applicable to INTERNET_ACCESS_PRODUCT
product type.Example: "property": "/service/routingProtocol/type", "operator": "=", "values": [ & & "BGP" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values:
|
/service/routingProtocol/ipv4/ customerRoute/ipBlock/prefixLength | IP v4 subnet size. Applicable to INTERNET_ACCESS_PRODUCT product
type.Example: "property": "/service/routingProtocol/ipv4/customerRoute/ipBlock/prefixLength", "operator": "=", "values": [ & & 28 ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[integer] REQUIRED |
Search field parameter value. Applicable values:
|
/service/routingProtocol/ipv6/ customerRoute/ipBlock/prefixLength | IP v6 subnet size. Applicable to INTERNET_ACCESS_PRODUCT product
type.Example: "property": "/service/routingProtocol/ipv6/customerRoute/ipBlock/prefixLength", "operator": "=", "values": [ & & 48 ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[integer] REQUIRED |
Search field parameter value. Applicable values:
|
/service/minBandwidthCommit | Minimum bandwidth commitment. Applicable to
INTERNET_ACCESS_PRODUCT product type, BURST_BASED
billing.Example: "property": "/service/minBandwidthCommit", "operator": "=", "values": [ & & 1000 ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[integer] REQUIRED |
Search field parameter value. Applicable values:
|
/ipBlock/type | IP block type. Applicable to IP_BLOCK_PRODUCT product
type.Example: "property": "/ipBlock/type", "operator": "=", "values": [ & & "IA_IP_BLOCK" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values: IA_IP_BLOCK |
/ipBlock/location/ibx | IBX data center identifier where the leased IP block is located. Applicable to
IP_BLOCK_PRODUCT product type.Example: "property": "/ipBlock/location/ibx", "operator": "=", "values": [ & & "WA1" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values: Use the Get IBX Data Centers API request to retrieve IBX data centers where Equinix Internet Access is available. |
/ipBlock/ipv4/prefixLength | IP v4 block size. Applicable to IP_BLOCK_PRODUCT product
type.Example: "property": "/ipBlock/ipv4/prefixLength", "operator": "=", "values": [ & & "USAGE_BASED" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values:
|
/ipBlock/ipv6/prefixLength | IP v6 block size. Applicable to IP_BLOCK_PRODUCT product
type.Example: "property": "/ipBlock/ipv6/prefixLength", "operator": "=", "values": [ & & "USAGE_BASED" ] |
operator string REQUIRED |
Search field parameter operator. Applicable values: = |
values array[string] REQUIRED |
Search field parameter value. Applicable values:
|
Sample response - Equinix Internet Access pricing
{
"data": [
{
"href": "https://api.equinix.com/internetAccess/v1/prices/search",
"type": "INTERNET_ACCESS_PRODUCT",
"code": "EC00015.PROD",
"name": "Internet Access Service Product",
"description": "Internet Access Service",
"account": {
"accountNumber": "123456"
},
"currency": "USD",
"category": "CUSTOMER",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 1750,
"unit": "ITEM",
"product": {
"type": "INTERNET_ACCESS_PRODUCT",
"code": "EC00015.PROD",
"name": "Internet Access Service Product",
"description": "Internet Access Service"
}
},
{
"type": "MONTHLY_RECURRING",
"price": 1.75,
"unit": "MBPS_1",
"product": {
"type": "INTERNET_ACCESS_PRODUCT",
"code": "EC00015.PROD",
"name": "Internet Access Service Product",
"description": "Internet Access Service"
}
},
{
"type": "NON_RECURRING",
"price": 750,
"unit": "ITEM",
"product": {
"type": "INTERNET_ACCESS_PRODUCT",
"code": "EC00015.PROD",
"name": "Internet Access Service Product",
"description": "Internet Access Service"
}
}
],
"summary": {
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 1750,
"unit": "ITEM"
},
{
"type": "NON_RECURRING",
"price": 750,
"unit": "ITEM"
}
],
"totalCharge": {
"price": 2500
}
},
"service": {
"type": "SINGLE_PORT",
"minBandwidthCommit": 1000,
"billing": "BURST_BASED",
"useCase": "MAIN",
"connection": {
"type": "IA_C",
"aSide": {
"accessPoint": {
"type": "COLO",
"location": {
"ibx": "DC5"
},
"port": {
"physicalPort": {
"speed": 1000
},
"physicalPortQuantity": 1
}
}
}
},
"routingProtocol": {
"type": "BGP",
"ipv4": {
"customerRoute": {
"ipBlock": {
"prefixLength": 28
}
}
},
"ipv6": {
"customerRoute": {
"ipBlock": {
"prefixLength": 48
}
}
}
}
}
}
],
"pagination": {
"offset": 0,
"limit": 50,
"total": 1
}
}
Sample response - IP block pricing
{
"data": [
{
"href": "https://api.equinix.com/internetAccess/v1/prices/search",
"type": "IP_BLOCK_PRODUCT",
"code": "EC00006.PROD",
"name": "Internet Access IP Addressing Product",
"description": "Internet Access IP Addressing",
"account": {
"accountNumber": "212179"
},
"currency": "USD",
"category": "CUSTOMER",
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 100.8,
"unit": "ITEM",
"product": {
"type": "IP_BLOCK_PRODUCT",
"code": "EC00006.PROD",
"name": "Internet Access IP Addressing Product",
"description": "Internet Access IP Addressing"
}
},
{
"type": "NON_RECURRING",
"price": 50,
"unit": "ITEM",
"product": {
"type": "IP_BLOCK_PRODUCT",
"code": "EC00006.PROD",
"name": "Internet Access IP Addressing Product",
"description": "Internet Access IP Addressing"
}
}
],
"summary": {
"charges": [
{
"type": "MONTHLY_RECURRING",
"price": 100.8,
"unit": "ITEM"
},
{
"type": "NON_RECURRING",
"price": 50,
"unit": "ITEM"
}
],
"totalCharge": {
"price": 150.8
}
},
"ipBlock": {
"type": "IA_IP_BLOCK",
"location": {
"ibx": "DC5"
},
"ipv4": {
"prefixLength": 28
}
}
}
],
"pagination": {
"offset": 0,
"limit": 50,
"total": 1
}
}
Response payload body description
Parameter
|
Description |
---|---|
data
array[object] |
Data set containing product pricing information. |
href
string |
Pricing information endpoint URL. |
type
string |
Product type. Possible values:
|
code
string |
Equinix-assigned product code. Example: EC00015.PROD |
name
string |
Full product name. Example: Internet Access Service Product |
description
string |
Product description. Example: Internet Access Service |
account
object |
Customer billing account data. |
accountNumber
string |
Customer billing account number. Example: 123456 |
currency
string |
Currency used for the offering price of the
product. Example: USD |
category
string |
Price category. Example: CUSTOMER |
charges
array[object] |
Details about charges. |
type
string |
Charge type. Possible values:
|
price
number |
Offering price. Example: 1750 |
unit
string |
Billable unit. Possible values:
|
product
object |
Product details. |
type
string |
Product type. Possible values:
|
code
string |
Equinix-assigned product code. Example: EC00015.PROD |
name
string |
Full product name. Example: Internet Access Service Product |
description
string |
Product description. Example: Internet Access Service |
summary
object |
Summary details of charges. |
charges
array[object] |
Details about charges. |
type
string |
Charge type. Possible values:
|
price
number |
Offering price. Example: 1.75 |
unit
string |
Billable unit. Possible values:
|
totalCharge
object |
Total charge details. |
price
number |
Total charge price. Example: 2500 |
service
object |
Equinix Internet Access service instance configuration. |
type
string |
Service type. Possible values:
|
bandwidth
integer |
Connection bandwidth in Mbps. Note: Applicable to FIXED billing.Example: 500 |
minBandwidthCommit
integer |
Minimum bandwidth commitment in Mbps. Note: Applicable to BURST_BASED and USAGE_BASED billing.Example: 500 |
billing
string |
Billing type. Possible values:
|
useCase
string |
Service use case. Possible values:
|
connection
object |
Connection details. |
type
string |
Connection type. Possible values:
|
aSide
object |
A-side connection configuration. |
accessPoint
object |
Access point object. |
type
string |
Type of access point. Possible values: COLO |
location
object |
Geographic data for the product. |
ibx
string |
IBX data center identifier. Example: DC5 |
port
object |
Port associated with the connection. |
physicalPort
object |
Physical port details. |
speed
integer |
Physical port bandwidth capacity in Mbps. Example: 1000 |
physicalPortQuantity
integer |
Number of physical ports. Example: 2 |
routingProtocol
object |
Routing protocol details. |
type
string |
Routing type. Possible values:
|
ipv4
object |
Routing protocol IP block for IP v4. |
customerRoute
object |
Customer route. |
ipBlock
object |
Customer IP block. |
prefixLength
integer |
The IP v4 routing prefix, or a subnet mask, is the network portion of an IP
address. Example: 29 |
importPolicy
string |
Customer route import policy. Possible values:
|
ipv6
object |
IP v6 IP block configuration. |
customerRoute
object |
Customer route. |
ipBlock
object |
Customer IP block. |
prefixLength
integer |
The IP v6 routing prefix, or a subnet mask, is the network portion of an IP
address. Example: 64 |
importPolicy
string |
Customer route import policy. Possible values:
|
ipBlock
object |
Configuration of the IP block to which the specified connections
belong. Note: Applicable to IP block pricing. |
type
string |
IP Block type. Possible values:
|
location
object |
Geographic data for the product. |
ibx
string |
IBX data center identifier in which the IP block is
located. Example: DC5 |
ipv4/ipv6
object |
IP v4/v6 subnet information. |
prefixLength
integer |
Routing prefix, or a subnet mask, is the network portion of an IP
address. Example: 28 |
pagination
object |
Data set pagination settings. |
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. |