Skip to main content
POST
Create Order
Create a new proxy order. The order is charged to the payment method on your account.

Request

Headers

Body Parameters

integer
required
Number of proxies to order. Must be greater than 0.
string
required
Type of proxy product to order. The following datacenter pool values are available:
string
Optional tag for grouping orders by your own customers. Letters a-z only, up to 50 characters. Uppercase letters are converted to lowercase.

Example Request

Response

Success Response

string
Status of the request. Returns "success" on successful order creation.
string
Unique identifier for the order. Use this to fetch proxy details.
string
Stripe subscription ID for billing management.
string
The proxy username for this order.
integer
The HTTP proxy port for this order.
The response does not include the proxy password. Call Get Order to fetch it along with your proxy list.

Error Responses

400 Bad Request - Missing Fields

400 Bad Request - Invalid Product Type

400 Bad Request - Invalid Quantity

400 Bad Request - Invalid Customer ID

400 Bad Request - Customer ID Too Long

400 Bad Request - Payment Failed

401 Unauthorized

500 Internal Server Error

Notes

  • Orders are charged right away to the payment method on your account
  • Proxies are assigned in the background after the order is created. If Get Order returns fewer proxies than you ordered, wait a moment and fetch again
  • The order_id is the subscription ID in lowercase. By default it is also the proxy username
  • If using an organization API key, the order is billed to the organization’s Stripe customer

List Orders

View all your active orders.

Get Order

Fetch proxy details for an order.