Generate Checkout Quote

POST

public

user

checkout

quote

curl --request POST \
  --url https://api.pingproxies.com/1.0/public/user/checkout/quote \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '{
  "country_id": "gb",
  "cycle_interval": "month",
  "cycle_interval_count": 1,
  "product_code": "isp_gb",
  "product_protocol": "ipv4",
  "product_type": "isp",
  "promotional_code": "NEWYEAR2025",
  "quantity": 1
}'

{
  "data": {
    "before_discount_total": 350,
    "credit_balance": 99050,
    "credit_only_checkout": true,
    "customer_credit_balance_applied": true,
    "customer_credit_balance_applied_amount": 350,
    "discount": 0,
    "discounted": false,
    "invalid_reason": "null",
    "is_top_up": false,
    "is_valid": true,
    "line_items": [
      {
        "item_country_id": "gb",
        "item_name": "Static Residential ISP Proxies [GB]",
        "item_per_unit_amount": 350,
        "item_price_id": "price_1QJx2DB2BUlqim5lxmO3aT2v",
        "item_price_type": "recurring",
        "item_quantity": 1,
        "item_total": 350,
        "item_type": "isp",
        "service_fulfillment_filter": {}
      }
    ],
    "promotional_code": "null",
    "promotional_code_id": "null",
    "top_up_amount": 0,
    "total": 350,
    "total_after_applied_credit": 0
  },
  "message": "Quote generated successfully."
}

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"

Response

200 - application/json

Quote generated successfully.

data

object

data.before_discount_total

integer

Total cost before any discounts.

Example:

350

data.credit_balance

integer

User's current credit balance.

Example:

99050

data.credit_only_checkout

boolean

Indicates if the checkout is credit only.

Example:

true

data.customer_credit_balance_applied

boolean

Indicates if the user's credit balance was used.

Example:

true

data.customer_credit_balance_applied_amount

integer

Amount of credit balance applied.

Example:

350

data.discount

integer

Discount amount applied.

Example:

0

data.discounted

boolean

Indicates if a discount was applied.

Example:

false

data.invalid_reason

string

Reason for the cart being invalid (only set if is_valid=false).

Example:

null

data.is_top_up

boolean

Indicates if the cart is for a top-up.

Example:

false

data.is_valid

boolean

Indicates if the cart is valid to checkout.

Example:

true

data.line_items

object[]

Detailed list of cart items.

data.line_items.item_country_id

string

Example:

"gb"

data.line_items.item_name

string

Example:

"Static Residential ISP Proxies [GB]"

data.line_items.item_per_unit_amount

integer

Example:

350

data.line_items.item_price_id

string

Example:

"price_1QJx2DB2BUlqim5lxmO3aT2v"

data.line_items.item_price_type

string

Example:

"recurring"

data.line_items.item_quantity

integer

Example:

1

data.line_items.item_total

integer

Example:

350

data.line_items.item_type

string

Example:

"isp"

data.line_items.service_fulfillment_filter

object

Additional filters for fulfillment (if any).

Example:

{}

data.promotional_code

string

Example:

null

data.promotional_code_id

string

Example:

null

data.top_up_amount

integer

Amount intended for credit top-up (if applicable).

Example:

0

data.total

integer

Total cost after discounts, before credit.

Example:

350

data.total_after_applied_credit

integer

Total cost after discounts and credit.

Example:

0

message

string

Success message.

Example:

"Quote generated successfully."

Retrieve Simplified Product Checkout Catalog Create Checkout

curl --request POST \
  --url https://api.pingproxies.com/1.0/public/user/checkout/quote \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '{
  "country_id": "gb",
  "cycle_interval": "month",
  "cycle_interval_count": 1,
  "product_code": "isp_gb",
  "product_protocol": "ipv4",
  "product_type": "isp",
  "promotional_code": "NEWYEAR2025",
  "quantity": 1
}'

{
  "data": {
    "before_discount_total": 350,
    "credit_balance": 99050,
    "credit_only_checkout": true,
    "customer_credit_balance_applied": true,
    "customer_credit_balance_applied_amount": 350,
    "discount": 0,
    "discounted": false,
    "invalid_reason": "null",
    "is_top_up": false,
    "is_valid": true,
    "line_items": [
      {
        "item_country_id": "gb",
        "item_name": "Static Residential ISP Proxies [GB]",
        "item_per_unit_amount": 350,
        "item_price_id": "price_1QJx2DB2BUlqim5lxmO3aT2v",
        "item_price_type": "recurring",
        "item_quantity": 1,
        "item_total": 350,
        "item_type": "isp",
        "service_fulfillment_filter": {}
      }
    ],
    "promotional_code": "null",
    "promotional_code_id": "null",
    "top_up_amount": 0,
    "total": 350,
    "total_after_applied_credit": 0
  },
  "message": "Quote generated successfully."
}

Customer

Proxy

Proxy User

Residential

Residential Ledger

Service

Service Adjustment

Checkout

Analytics

Product

ASN

Continent

Country

Subdivision

City

Authorizations

Headers

Body

Response