List Orders
Order API
List Orders
List all active and cancelled (not yet expired) orders for the authenticated user or organization.
GET
List Orders
Retrieve a list of all active and cancelled (not yet expired) orders. Optionally include proxy details, and optionally include expired orders, in the response.
Each order includes a
status field that is one of:
active— currently active and renewingcancelled— set to cancel at period end, but still usable until expirationexpired— past its expiration date (only returned wheninclude_expired=true)
Request
Headers
| Header | Value | Required |
|---|---|---|
Authorization | Bearer {your_api_key} | Yes |
Query Parameters
Set to
true to include proxy details in the response. Default is false.Set to
true to also include expired orders. Expired orders are excluded by default.Proxy format when
include_proxies=true. Options:ipup-ip:port:username:password(default)upip-username:password:ip:portupaip-username:password@ip:portobject- JSON object format
Example Requests
Get Order Summaries
Get Orders with Proxy Details
Get Orders with Custom Format
Include Expired Orders
Response
Success Response (Without Proxies)
Success Response (With Proxies)
Response Fields
Status of the request.
Summary statistics for all orders.
Total number of active orders.
Total number of proxies across all orders.
Breakdown of orders by product category.
Breakdown of orders by status (
active, cancelled, expired). Only statuses present in the result set are included.Array of order objects.
Order Object Fields
| Field | Type | Description |
|---|---|---|
order_id | string | Unique order identifier |
subscription_id | string | Stripe subscription ID |
status | string | Order status: active, cancelled (set to cancel at period end but still usable), or expired |
product_type | string | Product type identifier |
product_name | string | Human-readable product name |
product_category | string | Category (datacenter, residential) |
quantity | integer | Number of proxies |
unix_purchase_date | integer | Purchase timestamp |
unix_expiration_date | integer | Expiration timestamp |
customer | string | Customer identifier (if set) |
origination | string | Order source (api, dashboard) |
proxy_username | string | Proxy authentication username |
proxy_password | string | Proxy authentication password (only with include_proxies=true) |
proxies | array | List of proxy strings (only with include_proxies=true) |
Proxy Formats
Wheninclude_proxies=true, you can specify the format:
| Format | Example Output |
|---|---|
ipup (default) | 31.193.191.6:3128:username:password |
upip | username:password:31.193.191.6:3128 |
upaip | username:password@31.193.191.6:3128 |
object | {"ip": "31.193.191.6", "port": 3128, "username": "...", "password": "..."} |
