Sign in

v1

latestOpenAPI 3.0.32026-07-2246176.0 KB
API ordering

Place a wallet-paid order

Place a headless, wallet-paid order. The server forces pay_with_credit=1 and no_redirect=1 internally, so the order is debited from your wallet balance with no gateway redirect.

email, fname, and lname are derived from the authenticated identity. You can omit them, or pass them explicitly to override.

Permission: account:api_ordering:write (admin-grant-only — off by default for every account). Authenticate with the api-token header. The wallet balance must cover the order total at the moment the call lands.

post/v4/account/orders/create

Request body

type'new_datacenter_shared' | 'new_residential' | 'new_residential_unlimited' | 'new_serp_api' | 'update_datacenter_shared' | 'update_datacenter_dedicated' | 'update_residential' | 'update_residential_unlimited' | 'update_serp_api' required

Product to order. new_* creates a new subaccount; update_* upgrades an existing one in place (more proxies/tokens/bandwidth or extended duration) and requires account_id. Each update_* accepts the same product-specific fields as its matching new_* — see the examples below.

account_idstring

Required for update_* types: the AccountID of the subaccount to upgrade (from /v4/account/subaccounts). Must be a subaccount you own. Ignored for new_* types.

dry_runboolean

When true, returns a price quote without creating an order or debiting the wallet. Works for both new_* and update_*, and on a zero wallet balance.

countrystring

Billing country (full name, e.g. "Belgium"). Determines VAT. Required for new_* orders; optional for update_* (the subaccount's existing country is used).

coupon_codestring

Optional coupon. Discount applies before any per-account API-ordering percentage (coupon first, then percentage on the post-coupon price). Coupons cannot be applied to wallet top-ups.

fnamestring

Override the first name from the authenticated account.

lnamestring

Override the last name from the authenticated account.

Example request

{
  "account_id": "fe7941e6-1eed-4d95-881a-3159901897d3",
  "country": "Belgium",
  "coupon_code": "WELCOME10"
}

Response

For a real order: created and paid from the wallet — data is the bare order ID string. For dry_run: true: data is a price quote and no order is created or charged.

successboolean

Example response

{
  "success": true,
  "data": "0bc1a40f-2a17-4c84-9b2b-f4b9d3e0b3a1"
}