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-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>' \
  --data '{
  "cycle_interval": "month",
  "cycle_interval_count": 1,
  "product_code": "isp_us",
  "promotional_code": "HALFOFF",
  "quantity": 5
}'
{
  "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-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.

The body is of type object.

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.

The response is of type object.