Checkout

Create Checkout

This endpoint creates a checkout for the authenticated user based on the provided data. It supports different payment platforms, promotional codes, and can handle both one-time and recurring payments. You can either specify a product_code directly or supply the traditional combination of product_type, country_id, and product_protocol.

Important considerations

If product_code is provided alongside product_type/country_id/product_protocol, their values must match the actual product attributes.
If the invoice amount remaining is 0, it means your available credit fully covered the cost and the service is considered immediately paid.
If the invoice needs payment, you will be returned an invoice_url to complete checkout.

POST

public

user

checkout

create

curl --request POST \
  --url https://api.pingproxies.com/1.0/public/user/checkout/create \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '{
  "cycle_interval": "month",
  "cycle_interval_count": 1,
  "product_code": "isp_us",
  "promotional_code": "HALFOFF",
  "quantity": 5,
  "service_fulfillment_filter": {}
}'

{
  "data": {
    "created": [
      "API-1234-5678"
    ],
    "invoice_is_paid": true,
    "invoice_url": "https://invoice.stripe.com/i/acct_1H7dAB2BUlqim5l/test_123",
    "proxies": [
      {
        "asn_id": 7018,
        "asn_name": "AT&T Enterprises, LLC",
        "city_example_postcode": "75202",
        "city_id": 75202,
        "city_latitude": 32.7767,
        "city_longitude": -96.797,
        "city_name": "Dallas",
        "city_timezone": "America/Chicago",
        "country_id": "us",
        "country_name": "United States",
        "customer_id": 1976,
        "default_proxy_user_password": "apple1984",
        "default_proxy_user_username": "stevejobs",
        "ip_address_id_v4": "107.225.73.142",
        "ip_address_id_v6": "2600:1000:b12a:6351:8523:997e:93c4:f124",
        "proxy_http_port": 8080,
        "proxy_id": "7a018d34-76c2-4c23-b14d-f7b9a7054e25",
        "proxy_ip_address": "107.225.73.142",
        "proxy_ip_address_v6": "2600:1000:b12a:6351:8523:997e:93c4:f124",
        "proxy_last_update_datetime": "2023-11-07T05:31:56Z",
        "proxy_password": "DHf3PSQXQ7rw1v9",
        "proxy_protocol": "ipv4",
        "proxy_socks5_port": 1080,
        "proxy_status": "in_use",
        "proxy_type": "isp",
        "proxy_username": "att7018user",
        "service_id": "API-1234-5678",
        "subdivision_id": "us-tx",
        "subdivision_name": "Texas",
        "subnet_id": "107.225.72.0/22",
        "subnet_id_v6": "2600:1000::/28"
      }
    ],
    "proxy_edited": [
      "7a018d34-76c2-4c23-b14d-f7b9a7054e25"
    ],
    "residential_ledger_created": [],
    "service": {
      "country_id": "us",
      "customer_id": 1976,
      "open_invoice_id": "null",
      "payment_method_id": "null",
      "product_id": "prod_ATT7018",
      "service_creation_datetime": "2023-11-07T05:31:56Z",
      "service_cycle": "1:month",
      "service_dispatch_datetime": "2023-11-07T05:31:56Z",
      "service_earliest_cancellation_datetime": "2023-11-07T05:31:56Z",
      "service_expiry_datetime": "2023-11-07T05:31:56Z",
      "service_fulfillment_filter": {
        "asn_id": 7018
      },
      "service_id": "API-1234-5678",
      "service_image": "https://files.stripe.com/links/MDB8YWNjdF8xSDdkOEFCMkJVbHFpbTVsfGZsX2xpdmVfZFZ6TTZjUG01Q0NuR1IzSTZsVzNjVVFX00kUPPfQE9",
      "service_is_automatic_collection": true,
      "service_is_cancellable": true,
      "service_is_off_catalog": false,
      "service_is_pending_cancellation": false,
      "service_is_reconfigurable": true,
      "service_last_update_datetime": "2023-11-07T05:31:56Z",
      "service_metadata": {},
      "service_name": "AT&T ISP Proxies [US]",
      "service_price_id": "price_1QJx2DB2BUlqim5lxmO3aT2v",
      "service_promotional_code": "HALFOFF",
      "service_protocol": "ipv4",
      "service_quantity": 5,
      "service_status": "active",
      "service_subscription_id": "sub_1QxSHmB2BUlqim5lTUH8HvKa",
      "service_subscription_is_paused": false,
      "service_total": 450,
      "service_type": "isp",
      "subscription_schedule_id": "null"
    },
    "service_id": "API-1234-5678"
  },
  "message": "Successfully created checkout and paid with credit. Your service will be provisioned shortly."
}

Authorizations

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.

quantity

integer

required

The quantity of the product to purchase.

country_id

string

An ISO country code used for region-specific datacenter or ISP products.

cycle_interval

enum<string>

default:month

The billing interval for recurring purchases.

Available options:

year,

month,

week,

day

cycle_interval_count

integer

The number of intervals for a recurring cycle (e.g. 1 month, 2 months, etc.).

product_code

string

A direct product code (e.g. "datacenter_us"). If this is provided, you do not need product_type, country_id, or product_protocol.

product_protocol

enum<string>

default:ipv4

The protocol of the product.

Available options:

ipv4,

ipv6,

dual

product_type

enum<string>

The type of product to purchase (if product_code is not used).

Available options:

datacenter,

isp,

residential

promotional_code

string

A promotional code to apply a discount to the checkout.

service_fulfillment_filter

object

An optional filter object for advanced product/service configurations.

Response

201 - application/json

Successfully created a checkout. Depending on the remaining invoice amount, it may already be paid by credit, or you may need to complete payment at the returned invoice URL.

data

object

data.created

string[]

A list of service IDs created during checkout (usually contains only one).

Example:

["API-1234-5678"]

data.invoice_is_paid

boolean

Indicates whether the invoice is already paid.

Example:

true

data.invoice_url

string

URL where the user should be redirected to complete payment (null if paid in full).

Example:

"https://invoice.stripe.com/i/acct_1H7dAB2BUlqim5l/test_123"

data.proxies

object[]

A list of proxy objects tied to the newly created service.

data.proxy_edited

string[]

A list of proxies edited or updated in the process (may be empty).

Example:

["7a018d34-76c2-4c23-b14d-f7b9a7054e25"]

data.residential_ledger_created

string[]

A list of residential ledger entries created (may be empty).

Example:

[]

data.service

object

Detailed information about the provisioned service (null if not yet provisioned).

data.service.country_id

string

Example:

"us"

data.service.customer_id

integer

Example:

1976

data.service.open_invoice_id

string

Example:

null

data.service.payment_method_id

string

Example:

null

data.service.product_id

string

Example:

"prod_ATT7018"

data.service.service_creation_datetime

string

data.service.service_cycle

string

Example:

"1:month"

data.service.service_dispatch_datetime

string

data.service.service_earliest_cancellation_datetime

string

data.service.service_expiry_datetime

string

data.service.service_fulfillment_filter

object

Example:

{ "asn_id": 7018 }

data.service.service_id

string

Example:

"API-1234-5678"

data.service.service_image

string

Example:

"https://files.stripe.com/links/MDB8YWNjdF8xSDdkOEFCMkJVbHFpbTVsfGZsX2xpdmVfZFZ6TTZjUG01Q0NuR1IzSTZsVzNjVVFX00kUPPfQE9"

data.service.service_is_automatic_collection

boolean

Example:

true

data.service.service_is_cancellable

boolean

Example:

true

data.service.service_is_off_catalog

boolean

Example:

false

data.service.service_is_pending_cancellation

boolean

Example:

false

data.service.service_is_reconfigurable

boolean

Example:

true

data.service.service_last_update_datetime

string

data.service.service_metadata

object

Example:

{}

data.service.service_name

string

Example:

"AT&T ISP Proxies [US]"

data.service.service_price_id

string

Example:

"price_1QJx2DB2BUlqim5lxmO3aT2v"

data.service.service_promotional_code

string

Example:

"HALFOFF"

data.service.service_protocol

string

Example:

"ipv4"

data.service.service_quantity

integer

Example:

5

data.service.service_status

string

Example:

"active"

data.service.service_subscription_id

string

Example:

"sub_1QxSHmB2BUlqim5lTUH8HvKa"

data.service.service_subscription_is_paused

boolean

Example:

false

data.service.service_total

integer

Example:

450

data.service.service_type

string

Example:

"isp"

data.service.subscription_schedule_id

string

Example:

null

data.service_id

string

The ID of the newly created service.

Example:

"API-1234-5678"

message

string

Success message.

Example:

"Successfully created checkout and paid with credit. Your service will be provisioned shortly."

Generate Checkout Quote Graph Proxy Analytics

curl --request POST \
  --url https://api.pingproxies.com/1.0/public/user/checkout/create \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '{
  "cycle_interval": "month",
  "cycle_interval_count": 1,
  "product_code": "isp_us",
  "promotional_code": "HALFOFF",
  "quantity": 5,
  "service_fulfillment_filter": {}
}'

{
  "data": {
    "created": [
      "API-1234-5678"
    ],
    "invoice_is_paid": true,
    "invoice_url": "https://invoice.stripe.com/i/acct_1H7dAB2BUlqim5l/test_123",
    "proxies": [
      {
        "asn_id": 7018,
        "asn_name": "AT&T Enterprises, LLC",
        "city_example_postcode": "75202",
        "city_id": 75202,
        "city_latitude": 32.7767,
        "city_longitude": -96.797,
        "city_name": "Dallas",
        "city_timezone": "America/Chicago",
        "country_id": "us",
        "country_name": "United States",
        "customer_id": 1976,
        "default_proxy_user_password": "apple1984",
        "default_proxy_user_username": "stevejobs",
        "ip_address_id_v4": "107.225.73.142",
        "ip_address_id_v6": "2600:1000:b12a:6351:8523:997e:93c4:f124",
        "proxy_http_port": 8080,
        "proxy_id": "7a018d34-76c2-4c23-b14d-f7b9a7054e25",
        "proxy_ip_address": "107.225.73.142",
        "proxy_ip_address_v6": "2600:1000:b12a:6351:8523:997e:93c4:f124",
        "proxy_last_update_datetime": "2023-11-07T05:31:56Z",
        "proxy_password": "DHf3PSQXQ7rw1v9",
        "proxy_protocol": "ipv4",
        "proxy_socks5_port": 1080,
        "proxy_status": "in_use",
        "proxy_type": "isp",
        "proxy_username": "att7018user",
        "service_id": "API-1234-5678",
        "subdivision_id": "us-tx",
        "subdivision_name": "Texas",
        "subnet_id": "107.225.72.0/22",
        "subnet_id_v6": "2600:1000::/28"
      }
    ],
    "proxy_edited": [
      "7a018d34-76c2-4c23-b14d-f7b9a7054e25"
    ],
    "residential_ledger_created": [],
    "service": {
      "country_id": "us",
      "customer_id": 1976,
      "open_invoice_id": "null",
      "payment_method_id": "null",
      "product_id": "prod_ATT7018",
      "service_creation_datetime": "2023-11-07T05:31:56Z",
      "service_cycle": "1:month",
      "service_dispatch_datetime": "2023-11-07T05:31:56Z",
      "service_earliest_cancellation_datetime": "2023-11-07T05:31:56Z",
      "service_expiry_datetime": "2023-11-07T05:31:56Z",
      "service_fulfillment_filter": {
        "asn_id": 7018
      },
      "service_id": "API-1234-5678",
      "service_image": "https://files.stripe.com/links/MDB8YWNjdF8xSDdkOEFCMkJVbHFpbTVsfGZsX2xpdmVfZFZ6TTZjUG01Q0NuR1IzSTZsVzNjVVFX00kUPPfQE9",
      "service_is_automatic_collection": true,
      "service_is_cancellable": true,
      "service_is_off_catalog": false,
      "service_is_pending_cancellation": false,
      "service_is_reconfigurable": true,
      "service_last_update_datetime": "2023-11-07T05:31:56Z",
      "service_metadata": {},
      "service_name": "AT&T ISP Proxies [US]",
      "service_price_id": "price_1QJx2DB2BUlqim5lxmO3aT2v",
      "service_promotional_code": "HALFOFF",
      "service_protocol": "ipv4",
      "service_quantity": 5,
      "service_status": "active",
      "service_subscription_id": "sub_1QxSHmB2BUlqim5lTUH8HvKa",
      "service_subscription_is_paused": false,
      "service_total": 450,
      "service_type": "isp",
      "subscription_schedule_id": "null"
    },
    "service_id": "API-1234-5678"
  },
  "message": "Successfully created checkout and paid with credit. Your service will be provisioned shortly."
}

Customer

Proxy

Proxy User

Residential

Residential Ledger

Service

Service Adjustment

Checkout

Analytics

Product

ASN

Continent

Country

Subdivision

City

Create Checkout

Authorizations

Headers

Body

Response