Skip to content

Search prices

For the complete documentation index see: llms.txt

All documentation pages available in markdown.

GET
/pricing/prices

Returns a list of prices, filtered by any combination of price attributes. Each price in the response includes the currently effective rate (currentRate) embedded in-line so the caller does not need a second round-trip.

Identifier-style filters region and priceDetail accept the short human-readable name (e.g. use2, i4i.large). The provider filter is constrained to a fixed enum (aws, gcp).

Authorizations

Parameters

Query Parameters

meteringTerm

Metering term applied to a price.

  • ond — on-demand; metered as usage is incurred.
  • hr — hourly; reserved/committed at an hourly rate.
  • ann — annual; committed for a one-year term.
  • fixed — fixed; one-time, non-recurring flat fee.
string
Allowed values:
ond
hr
ann
fixed
Example:
hr

Filter by metering term.

priceType

Top-level pricing category.

  • compute — dedicated compute infrastructure.
  • networktransfer — network transfer activities.
  • services — support packages and professional services.
string
Allowed values:
compute
networktransfer
services
Example:
compute

Filter by price type.

priceSubtype

Sub-category within a pricing category. Valid subtypes are scoped to a parent PriceType:

  • compute: unmanaged, managed
  • networktransfer: xregion, xzone, public
  • services: support, professional
string
Allowed values:
unmanaged
managed
xregion
xzone
public
support
professional
Example:
managed

Filter by price subtype.

provider
string
Allowed values:
aws
gcp

Filter by cloud provider.

Example
Example:
aws
region
string

Filter by region code (e.g. use2).

Example
Example:
use2
priceDetail
string

Filter by price detail. For compute prices accepts an instance name (e.g. i4i.large).

Example
Example:
i4i.large
status
string
Allowed values:
active
inactive
deprecated

Filter by price status. Defaults to active.

priceCode
string

Exact match on price code, or prefix match using a trailing * wildcard (e.g. ond-compute-*). Price codes are lowercase, hyphen-separated; the positional structure varies by priceType — see the priceCode field on the response schema for the per-type format.

Example
Example:
ond-compute-*
limit
integer
>= 1
<= 100

Maximum number of prices to return. When neither limit nor offset is supplied, all matching prices are returned (no pagination). Supplying either parameter enables pagination; limit then defaults to 10.

Example
Example:
10
offset
integer

The number of items to skip before starting to return results. Used for pagination. For example, to get the next 10 items after the first 10, set offset to 10. Note: pagination is currently disabled, this parameter is accepted but ignored and the full result set is returned.

Responses

200

A collection of prices

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema
object
meta

Pagination metadata. limit and offset are present only when the request paginated (a limit or offset query parameter was supplied). When neither is supplied the full result set is returned and both are omitted; total is always present.

object
total
required

Total number of items available

integer
Example:
1000
limit

Maximum number of items per page. Omitted when the request did not paginate.

integer
Example:
10
offset

Number of items skipped before the current result set. Omitted when the request did not paginate.

integer
Example:
10
prices
required
Array<object>

A price for a SKU, with the currently effective rate embedded in-line.

object
id
required

Stable identifier for the price.

string
format: uuid
priceCode
required

Structured, lowercase, hyphen-separated price code. The positional structure varies by priceType:

  • Compute — {term}-compute-{subtype}-{provider}-{region}-{detail} (e.g. ann-compute-managed-aws-use2-i4i.2xlarge, hr-compute-managed-aws-use2-i4i.2xlarge).
  • Network transfer — {term}-networktransfer-{subtype}-{provider}-{region1}[-{region2}] (e.g. ond-networktransfer-regional-aws-apj1-use2, ond-networktransfer-public-aws-apj1).
  • Services — {term}-services-{subtype}-{detail} (e.g. ann-services-support-platinum, ond-services-professional-scoped).
string
Example:
hr-compute-managed-aws-use2-i4i.2xlarge
displayName
required

Human-readable label for the price.

string
Example:
Hourly - Managed Compute – AWS i4i.large (us-east-2)
status
required

Lifecycle status of a price.

string
Allowed values:
active
inactive
deprecated
Example:
active
currentRate
required

The rate currently in effect for this price. Null if no rate is currently active.

object
id
required

Stable identifier for the rate.

string
format: uuid
unitRate
required

Cost per unit, in the rate’s currency, expressed as a decimal string to preserve precision.

string
Example:
0.32
unit
required

The unit a rate is metered against.

string
Allowed values:
hour
month
year
gb
request
Example:
hour
currency
required

ISO 4217 currency code.

string
>= 3 characters
<= 3 characters
Example:
USD
effectiveFrom
required

Inclusive timestamp from which this rate is effective.

string
format: date-time
effectiveTo

Exclusive timestamp at which this rate is superseded. Null for the currently-effective rate.

string
format: date-time
nullable
Example
Content type: application/json
{ 
{
"meta": { 
"total": 1000,
"limit": 10,
"offset": 10
},
"prices": [ 
{ 
"id": "string",
"priceCode": "hr-compute-managed-aws-use2-i4i.2xlarge",
"displayName": "Hourly - Managed Compute – AWS i4i.large (us-east-2)",
"status": "active",
"currentRate": { 
"id": "string",
"unitRate": "0.32",
"unit": "hour",
"currency": "USD",
"effectiveFrom": "string",
"effectiveTo": "string"
}
}
]
}

400

Invalid input

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:cluster:locked
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:validation:failed", "title": "Validation Error", "status": 400, "detail": "The provided information is not in the correct format.", "instance": "string", "context": { "invalid": [ { "field": "/name", "type": "urn:aerospike:errors:validation:too-long" }, { "field": "/region", "type": "urn:aerospike:errors:validation:too-short" } ] }, "message": "The provided information is not in the correct format." }

401

Access token is missing or invalid

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:cluster:locked
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:auth:token-expired", "title": "Token Expired", "status": 401, "detail": "Your session has expired. Please log in again.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "Your session has expired. Please log in again." }

403

Permission denied

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:cluster:locked
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:auth:unauthorized", "title": "Unauthorized", "status": 403, "detail": "You don't have permission to access this resource.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "You don't have permission to access this resource." }

500

Internal Server Error

Response Headers
X-Request-Id
string
Example:
b0658b67-8ea3-46de-a3b8-18c3f5347def

ID uniquely identifying the request/response cycle.

Response Schema

RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses.

object
type
required

URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific}

Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN.

string
Allowed values:
urn:aerospike:errors:auth:unauthorized
urn:aerospike:errors:auth:token-expired
urn:aerospike:errors:resource:not-found
urn:aerospike:errors:resource:already-exists
urn:aerospike:errors:cluster:locked
urn:aerospike:errors:validation:failed
urn:aerospike:errors:system:internal
urn:aerospike:errors:system:unavailable
urn:aerospike:errors:ratelimit:exceeded
title
required

A short, human-readable summary of the problem type

string
Example:
Resource Not Found
status
required

The HTTP status code

integer
Example:
404
detail

A human-readable explanation specific to this occurrence

string
Example:
The requested cluster could not be found.
instance

A URI reference that identifies the specific occurrence

string
format: uri
context
Any of:

Context for resource-related errors (not-found, already-exists)

object
resource

Type of resource (e.g., cluster, database, organization)

string
Example:
cluster
id

Identifier of the resource

string
Example:
abc-123
message

Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead.

string
Example:
The requested cluster could not be found.
Example
Example:
{ "type": "urn:aerospike:errors:system:internal", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred. Please try again later.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "An unexpected error occurred. Please try again later." }
Feedback

Was this page helpful?

What type of feedback are you giving?

What would you like us to know?

+Capture screenshot

Can we reach out to you?