Skip to main content
POST
Generate Checkout Quote

Authorizations

X-API-Private-Key
string
header
required

Private API key for user-level authentication.

X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Headers

Content-Type
string
default:application/json
required

Content type for the request body as application/json.

Body

application/json

The data needed to create the checkout quote.

quantity
integer
required

The quantity of the product you would like to purchase.

Example:

1

country_id
string

The ISO country code of the product. Applicable for region-specific datacenter/isp products.

Example:

"gb"

cycle_interval
enum<string>
default:month

The interval of the product.

Available options:
year,
month,
week,
day
Example:

"month"

cycle_interval_count
integer

The interval count of the product.

Example:

1

product_code
string

If provided, this overrides product_type, country_id, and product_protocol. The cycle must still be valid for this product_code.

Example:

"isp_gb"

product_protocol
enum<string>
default:ipv4

The protocol of the product.

Available options:
ipv4,
ipv6,
dual
Example:

"ipv4"

product_type
enum<string>

The product type you would like to purchase.

Available options:
datacenter,
isp,
residential
Example:

"isp"

promotional_code
string

Promotional code to apply to the checkout.

Example:

"NEWYEAR2025"

service_fulfillment_filter
object
Example:

Response

200 - application/json

Quote generated successfully.

data
object
message
string

Success message.

Example:

"Quote generated successfully."