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.

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

line_items
object[]

Multi-location form: a list containing exactly one line item that carries its own product type, billing cycle, quantity, and optional per-location filter. Mutually exclusive with the top-level product_code, product_type, country_id, product_protocol, cycle_interval, cycle_interval_count, quantity, and service_fulfillment_filter fields (promotional_code remains top-level).

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,
mobile
Example:

"isp"

promotional_code
string

Promotional code to apply to the checkout.

Example:

"PROMOCODEHERE"

quantity
integer

The quantity of the product you would like to purchase. Required for the legacy flat form (the line_items form uses item_quantity instead).

Example:

1

service_fulfillment_filter
object

Legacy single-object filter applied to the whole service (e.g. {"asn_id": 7018}), pinned to the product's country. For multi-location allocation use line_items instead. asn_id requires an account permission; insufficient stock matching the filter rejects with 422.

Example:

Response

200 - application/json

Quote generated successfully.

data
object
message
string

Success message.

Example:

"Quote generated successfully."