v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Checkout

Retrieve Simplified Product Checkout Catalog

This endpoint returns a simplified product list that is both visible and enabled for API checkouts. It helps clients to quickly identify and purchase available products without any search or pagination parameters. Ideal for basic API-based purchasing.

get/public/user/checkout/catalog

Response

Successfully retrieved the simplified checkout catalog.

dataobject

Object containing available products keyed by product ID

messagestring

A success message.

Example response

{
  "data": {
    "datacenter_us": {
      "country_id": "us",
      "product_cycle_options": [
        "1:month",
        "3:month",
        "1:year"
      ],
      "product_is_available": true,
      "product_is_per_ip": true,
      "product_name": "Datacenter Proxies [US]",
      "product_protocol": "ipv4",
      "product_stock": 10,
      "product_type": "datacenter"
    },
    "isp_gb": {
      "country_id": "gb",
      "product_cycle_options": [
        "1:month",
        "3:month",
        "1:year"
      ],
      "product_is_available": true,
      "product_is_per_ip": true,
      "product_name": "Static Residential ISP Proxies [GB]",
      "product_protocol": "ipv4",
      "product_stock": 181,
      "product_type": "isp"
    }
  },
  "message": "Checkout catalog successfully retrieved."
}