Generate Checkout Quote
This endpoint allows a user to generate a quote for a service via the API. The product can be configured in one of two mutually exclusive forms:
- Legacy flat form: a
product_codedirectly, or the traditional combination ofproduct_type,country_id, andproduct_protocol, with a top-levelquantity. - Multi-location form: a single
line_itemsentry carrying its own product type, billing cycle, quantity, and per-locationservice_fulfillment_filter.
Example: multi-location quote (line_items form)
{
"line_items": [
{
"product_type": "isp",
"item_quantity": 5,
"cycle_interval": "month",
"cycle_interval_count": 1,
"service_fulfillment_filter": [
{"country_id": "us", "quantity": 2},
{"country_id": "gb", "quantity": 2}
]
}
],
"promotional_code": "PROMOCODEHERE"
}
Authorizations
Private API key for user-level authentication.
Public API key for user-level authentication.
Headers
Content type for the request body as application/json.
Body
The data needed to create the checkout quote.
The ISO country code of the product. Applicable for region-specific datacenter/isp products.
"gb"
The interval of the product.
year, month, week, day "month"
The interval count of the product.
1
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).
If provided, this overrides product_type, country_id, and product_protocol. The cycle must still be valid for this product_code.
"isp_gb"
The protocol of the product.
ipv4, ipv6, dual "ipv4"
The product type you would like to purchase.
datacenter, isp, residential, mobile "isp"
Promotional code to apply to the checkout.
"PROMOCODEHERE"
The quantity of the product you would like to purchase. Required for the legacy flat form (the line_items form uses item_quantity instead).
1
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.

