Skip to content

The same pricing, plan discount, stock check and balance check apply. Protocol, location, target domains or all-sites mode, and all add-ons are supported.

If you don't send a username and password, they are generated and returned in the response (if the token also has proxies:read). If you don't send a service name, one is generated in the panel's format. Which fields apply to each type is in the table on the Operations that spend money page; unknown fields are rejected.

The order may not be active right away (provisioning, pre-order or a provider delay). If meta.ready is false, meta.warning is filled in; before you put the service to use, poll the Service details endpoint until state is active.

Authorization

Authorizationstringrequired

Sent as Bearer <token>. This endpoint needs the orders:write (Ordering) scope; a token without it gets 403.

Headers

Idempotency-Keystringheaderrequired

A unique value for each order attempt (e.g. a UUID). On a timeout, retry with the SAME value; you are not charged twice. Keep the value in a variable; don't generate a new one for the retry.

Body

orderTypeenum<string>required

Service type; mobile on this page.

highConnectionboolean

High connection. A paid add-on in the ISP family: 100 concurrent connections per IP instead of 50. Free on Residential/Mobile: the gateway connection limit is 1000 instead of 500; it shows in the response as options.high_connection.

countryCodestring

Residential/Mobile: default country at the order level, as an ISO code (TR, DE, US, GB, FR, IT, ES, NL, PL, RU). In the ISP family the country comes from locationId; sending it there is rejected.

gbLimitnumber

Residential/Mobile, optional: traffic limit (GB), at least 0.001. 0 means no fixed limit. If not sent, the quota is capped by your balance.

usernamestring

Optional; if not sent, it is generated and returned in the response. 3-40 characters: letters, digits, _ or -. To choose it yourself, your plan must allow it; if it doesn't, you get tier_required.

passwordstring

Optional; if not sent, it is generated. 6-40 characters; @ . : ! and spaces are not allowed. It cannot be the same as the username. Percent-encode a password that contains # / ? % when you use it inside a URL (e.g. socks5://user:pass@host); passwords generated by the system never contain #.

gateNamestring

Optional. The service name shown in the panel, up to 80 characters. If not sent, it is generated in the panel's format (e.g. ISP Proxy #a1b2c3d4).

Response

200
application/json
dataobject
metaobject