API ordering

Read order status

Returns the lifecycle state of a previously placed order. Consumers POST /v4/account/orders/create, then poll this endpoint every 1–2 seconds with the returned order_id until status === "processed". At that point data.subaccount is populated with the same shape /v4/account/subaccounts emits, so the caller can drop it straight into per-product endpoints like /v4/account/{AccountID}/datacenter_shared/proxy-list.

Gated on account:api_ordering:read. The order’s email must match the authenticated identity — mismatches return 404 (not 403) so existence isn’t leaked.

GET

account

orders

{orderId}

status

Read order status

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/orders/{orderId}/status \
  --header 'api-token: <api-key>'

import requests

url = "https://api.proxyscrape.com/v4/account/orders/{orderId}/status"

headers = {"api-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

fetch('https://api.proxyscrape.com/v4/account/orders/{orderId}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "data": {
    "order_id": "e905531c-a2cb-42a4-8df1-182040f369ae",
    "status": "processed",
    "type": "new_datacenter_shared",
    "created_at": 1781256420,
    "updated_at": 1781256827,
    "price": "26.10",
    "currency": "USD",
    "paid_with_credit": true,
    "subaccount": {
      "AccountID": "711d0eff-db25-439e-83dd-e8b81c38cb70",
      "AccountType": "datacenter_shared",
      "label": "Account 8 (Premium)",
      "time_added": 1781256827
    }
  }
}

{
  "success": false,
  "message": "Could not determine account email from authenticated identity."
}

{
  "success": false,
  "message": "Reading order status via the API-ordering endpoint is not enabled for this account. Contact support to request access."
}

{
  "success": false,
  "message": "Order not found."
}

Authorizations

api-token

string

header

required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Path Parameters

orderId

string<uuid>

required

Order ID returned by POST /v4/account/orders/create.

Response

Order status. subaccount is null while the order is still being processed; once status === 'processed' the field is populated with the new subaccount's AccountID, AccountType, label, and time_added.

success

boolean

Example:

true

data

object

Show child attributes

Read wallet balanceReturns the authenticated caller's wallet balance and currency. Authenticate with the `api-token` header. The email is derived server-side from the auth identity, so a token can only ever read its own wallet (IDOR-safe). By default this is an O(1) wallet primary-key lookup (`balance` + `currency` only). Pass `include_counts=1` to also return `topups_count` and `purchases_count` (email-scoped compound indexes on orders). Gated on `account:api_ordering:read` for API keys (admin-grant-only; off by default).

Read order status

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/orders/{orderId}/status \
  --header 'api-token: <api-key>'

import requests

url = "https://api.proxyscrape.com/v4/account/orders/{orderId}/status"

headers = {"api-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

fetch('https://api.proxyscrape.com/v4/account/orders/{orderId}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success": true,
  "data": {
    "order_id": "e905531c-a2cb-42a4-8df1-182040f369ae",
    "status": "processed",
    "type": "new_datacenter_shared",
    "created_at": 1781256420,
    "updated_at": 1781256827,
    "price": "26.10",
    "currency": "USD",
    "paid_with_credit": true,
    "subaccount": {
      "AccountID": "711d0eff-db25-439e-83dd-e8b81c38cb70",
      "AccountType": "datacenter_shared",
      "label": "Account 8 (Premium)",
      "time_added": 1781256827
    }
  }
}

{
  "success": false,
  "message": "Could not determine account email from authenticated identity."
}

{
  "success": false,
  "message": "Reading order status via the API-ordering endpoint is not enabled for this account. Contact support to request access."
}

{
  "success": false,
  "message": "Order not found."
}