Skip to main content
POST
Create order
Places a new proxy order. The proxies are provisioned immediately after a successful payment. Use "payment_method": "wallet" to deduct from your wallet balance instantly, or "payment_method": "cryptocloud" to pay with crypto and receive a redirect URL.
Send an idempotency_key to make this request safe to retry. See Idempotency.

Request body

integer
required
ID of the proxy offer from the catalog.
string
required
wallet or cryptocloud.
string
default:"residential"
Proxy type: datacenter, residential, or mobile.
string
default:"IPv4"
IPv4 or IPv6.
string
default:"HTTP"
HTTP, HTTPS, or SOCKS5.
string
default:"US"
ISO 3166-1 alpha-2 country code.
string
Optional city for geo-targeting.
string
Optional ISP filter.
integer
default:"1"
Number of proxies.
integer
default:"30"
Rental period in days. For offers that require a tarification_index, must match the chosen option’s period_days exactly.
integer
Index into the offer’s options array. Required for mobile rotating offers, which sell only pre-registered tariff triples; pass the index of the option the user picked. Ignored for other offers and rejected with 422 if supplied for them.
integer
Optional traffic limit in GB. Leave unset for unlimited (where supported).
boolean
default:"false"
Automatically renew when the period ends.
string
Optional private notes for your reference.
string
UUID for idempotent request handling.

Response

string
Order UUID.
string
Order status. One of: pending, pending_payment, active, failed, cancelled, expired.
number
Total charged in USD.
object
array
Populated once the order is active. Each item:

Example — wallet payment