Create a customer account

POST

/users

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://api.proxyrequest.com/api/v1/users");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Accept-Language: de");
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"email\": \"[email protected]\", \"username\": \"developer\", \"password\": \"Correct-Horse-Battery-Staple-42\", \"first_name\": \"Dana\", \"last_name\": \"Morgan\", \"country\": \"us\", \"state\": \"state\", \"city\": \"los_angeles\", \"address\": \"address\", \"zip\": \"zip\", \"blocked_domains\": [ \"blocked.example\" ], \"allowed_ips\": [ \"198.51.100.25\" ], \"connection_limit\": 1, \"is_reseller\": false, \"is_top_level\": false, \"data\": 1073741824, \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"package_connection_limit\": 1, \"meta\": {} }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.proxyrequest.com/api/v1/users"),
    Headers =
    {
        { "Accept-Language", "de" },
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"email\": \"[email protected]\", \"username\": \"developer\", \"password\": \"Correct-Horse-Battery-Staple-42\", \"first_name\": \"Dana\", \"last_name\": \"Morgan\", \"country\": \"us\", \"state\": \"state\", \"city\": \"los_angeles\", \"address\": \"address\", \"zip\": \"zip\", \"blocked_domains\": [ \"blocked.example\" ], \"allowed_ips\": [ \"198.51.100.25\" ], \"connection_limit\": 1, \"is_reseller\": false, \"is_top_level\": false, \"data\": 1073741824, \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"package_connection_limit\": 1, \"meta\": {} }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.proxyrequest.com/api/v1/users"

  payload := strings.NewReader("{ \"email\": \"[email protected]\", \"username\": \"developer\", \"password\": \"Correct-Horse-Battery-Staple-42\", \"first_name\": \"Dana\", \"last_name\": \"Morgan\", \"country\": \"us\", \"state\": \"state\", \"city\": \"los_angeles\", \"address\": \"address\", \"zip\": \"zip\", \"blocked_domains\": [ \"blocked.example\" ], \"allowed_ips\": [ \"198.51.100.25\" ], \"connection_limit\": 1, \"is_reseller\": false, \"is_top_level\": false, \"data\": 1073741824, \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"package_connection_limit\": 1, \"meta\": {} }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Accept-Language", "de")
  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.proxyrequest.com/api/v1/users"))
    .header("Accept-Language", "de")
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"email\": \"[email protected]\", \"username\": \"developer\", \"password\": \"Correct-Horse-Battery-Staple-42\", \"first_name\": \"Dana\", \"last_name\": \"Morgan\", \"country\": \"us\", \"state\": \"state\", \"city\": \"los_angeles\", \"address\": \"address\", \"zip\": \"zip\", \"blocked_domains\": [ \"blocked.example\" ], \"allowed_ips\": [ \"198.51.100.25\" ], \"connection_limit\": 1, \"is_reseller\": false, \"is_top_level\": false, \"data\": 1073741824, \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"package_connection_limit\": 1, \"meta\": {} }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"email\": \"[email protected]\", \"username\": \"developer\", \"password\": \"Correct-Horse-Battery-Staple-42\", \"first_name\": \"Dana\", \"last_name\": \"Morgan\", \"country\": \"us\", \"state\": \"state\", \"city\": \"los_angeles\", \"address\": \"address\", \"zip\": \"zip\", \"blocked_domains\": [ \"blocked.example\" ], \"allowed_ips\": [ \"198.51.100.25\" ], \"connection_limit\": 1, \"is_reseller\": false, \"is_top_level\": false, \"data\": 1073741824, \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"package_connection_limit\": 1, \"meta\": {} }");
Request request = new Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/users")
  .post(body)
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://api.proxyrequest.com/api/v1/users',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  data: {
    email: '[email protected]',
    username: 'developer',
    password: 'Correct-Horse-Battery-Staple-42',
    first_name: 'Dana',
    last_name: 'Morgan',
    country: 'us',
    state: 'state',
    city: 'los_angeles',
    address: 'address',
    zip: 'zip',
    blocked_domains: ['blocked.example'],
    allowed_ips: ['198.51.100.25'],
    connection_limit: 1,
    is_reseller: false,
    is_top_level: false,
    data: 1073741824,
    package_id: '550e8400-e29b-41d4-a716-446655440002',
    package_connection_limit: 1,
    meta: {}
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.proxyrequest.com/api/v1/users';
const options = {
  method: 'POST',
  headers: {
    'Accept-Language': 'de',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"email":"[email protected]","username":"developer","password":"Correct-Horse-Battery-Staple-42","first_name":"Dana","last_name":"Morgan","country":"us","state":"state","city":"los_angeles","address":"address","zip":"zip","blocked_domains":["blocked.example"],"allowed_ips":["198.51.100.25"],"connection_limit":1,"is_reseller":false,"is_top_level":false,"data":1073741824,"package_id":"550e8400-e29b-41d4-a716-446655440002","package_connection_limit":1,"meta":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"email\": \"[email protected]\", \"username\": \"developer\", \"password\": \"Correct-Horse-Battery-Staple-42\", \"first_name\": \"Dana\", \"last_name\": \"Morgan\", \"country\": \"us\", \"state\": \"state\", \"city\": \"los_angeles\", \"address\": \"address\", \"zip\": \"zip\", \"blocked_domains\": [ \"blocked.example\" ], \"allowed_ips\": [ \"198.51.100.25\" ], \"connection_limit\": 1, \"is_reseller\": false, \"is_top_level\": false, \"data\": 1073741824, \"package_id\": \"550e8400-e29b-41d4-a716-446655440002\", \"package_connection_limit\": 1, \"meta\": {} }")
val request = Request.Builder()
  .url("https://api.proxyrequest.com/api/v1/users")
  .post(body)
  .addHeader("Accept-Language", "de")
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api.proxyrequest.com/api/v1/users";

    let payload = json!({
        "email": "[email protected]",
        "username": "developer",
        "password": "Correct-Horse-Battery-Staple-42",
        "first_name": "Dana",
        "last_name": "Morgan",
        "country": "us",
        "state": "state",
        "city": "los_angeles",
        "address": "address",
        "zip": "zip",
        "blocked_domains": ("blocked.example"),
        "allowed_ips": ("198.51.100.25"),
        "connection_limit": 1,
        "is_reseller": false,
        "is_top_level": false,
        "data": 1073741824,
        "package_id": "550e8400-e29b-41d4-a716-446655440002",
        "package_connection_limit": 1,
        "meta": json!({})
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Accept-Language", "de".parse().unwrap());
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url https://api.proxyrequest.com/api/v1/users \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "[email protected]", "username": "developer", "password": "Correct-Horse-Battery-Staple-42", "first_name": "Dana", "last_name": "Morgan", "country": "us", "state": "state", "city": "los_angeles", "address": "address", "zip": "zip", "blocked_domains": [ "blocked.example" ], "allowed_ips": [ "198.51.100.25" ], "connection_limit": 1, "is_reseller": false, "is_top_level": false, "data": 1073741824, "package_id": "550e8400-e29b-41d4-a716-446655440002", "package_connection_limit": 1, "meta": {} }'

wget --quiet \
  --method POST \
  --header 'Accept-Language: de' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "email": "[email protected]", "username": "developer", "password": "Correct-Horse-Battery-Staple-42", "first_name": "Dana", "last_name": "Morgan", "country": "us", "state": "state", "city": "los_angeles", "address": "address", "zip": "zip", "blocked_domains": [ "blocked.example" ], "allowed_ips": [ "198.51.100.25" ], "connection_limit": 1, "is_reseller": false, "is_top_level": false, "data": 1073741824, "package_id": "550e8400-e29b-41d4-a716-446655440002", "package_connection_limit": 1, "meta": {} }' \
  --output-document \
  - https://api.proxyrequest.com/api/v1/users

Creates a sub-user under the caller by default. A superuser can send is_top_level=true to create an independent customer account. A sub-user cannot create another generation of users. Omit package_id and data to create identity only, then provision the chosen accounting model separately. For shared-pool allocation, supply package_id and positive integer-byte data; the parent must already own a root order for that package. An independent paid purchase is provisioned through invoices, not a shared-pool quota.

Authorizations

BearerAuth
StaticAuth

Parameters

Header Parameters

Idempotency-Key

string

<= 255 characters

Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request returns 409.

Accept-Language

string

default: en

Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Examples

de

fr-CA, fr;q=0.9, en;q=0.5

Request Body^required

Fields accepted when a reseller or administrator creates a customer account.

object

email

User’s email address. Must be unique if provided.

string format: email

username

required

Unique username for the account. Must be 3-128 characters.

string

>= 3 characters <= 128 characters

password

required

Account password. Must be 8-128 characters long.

string

>= 8 characters <= 128 characters

first_name

User’s first name.

string

<= 128 characters

last_name

User’s last name.

string

<= 128 characters

country

User’s country of residence.

string

<= 128 characters

state

User’s state or province.

string

<= 128 characters

city

User’s city.

string

<= 128 characters

address

User’s street address.

string

<= 128 characters

zip

User’s postal/ZIP code.

string

<= 128 characters

blocked_domains

List of domains to block for this user.

Array<string>

allowed_ips

List of source IP addresses allowed for this user. The maximum list size is configured per deployment.

Array<string>

connection_limit

Maximum number of concurrent connections allowed for the user.

integer

>= -1 <= 1000000

is_reseller

Whether the user should have reseller privileges. Only superusers can create resellers.

boolean

is_top_level

Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.

boolean

data

Initial integer-byte data amount. With package_id, a normal sub-user receives traffic from the caller’s root order: ordinary callers transfer available balance, while resellers grant a virtual quota; is_top_level=true provisions a separate paid purchase. Omit both data and package_id to create identity without package access.

integer

package_id

ProxyRequest package UUID to assign to the user. Headless integrations resolve it from their local product mapping.

string format: uuid

package_connection_limit

Connection limit for the initially assigned sub-user package only. Use -1 for package settings. Requires package_id and positive data; cannot be combined with connection_limit or is_top_level=true.

integer

>= -1 <= 1000000

meta

Additional metadata for the user. Maximum 50 fields.

object

key

additional properties

Examples

example

Example request

{
  "email": "[email protected]",
  "username": "developer",
  "password": "Correct-Horse-Battery-Staple-42",
  "first_name": "Dana",
  "last_name": "Morgan",
  "country": "us",
  "state": "state",
  "city": "los_angeles",
  "address": "address",
  "zip": "zip",
  "blocked_domains": [
    "blocked.example"
  ],
  "allowed_ips": [
    "198.51.100.25"
  ],
  "connection_limit": 1,
  "is_reseller": false,
  "is_top_level": false,
  "data": 1073741824,
  "package_id": "550e8400-e29b-41d4-a716-446655440002",
  "package_connection_limit": 1,
  "meta": {}
}

Fields accepted when a reseller or administrator creates a customer account.

object

email

User’s email address. Must be unique if provided.

string format: email

username

required

Unique username for the account. Must be 3-128 characters.

string

>= 3 characters <= 128 characters

password

required

Account password. Must be 8-128 characters long.

string

>= 8 characters <= 128 characters

first_name

User’s first name.

string

<= 128 characters

last_name

User’s last name.

string

<= 128 characters

country

User’s country of residence.

string

<= 128 characters

state

User’s state or province.

string

<= 128 characters

city

User’s city.

string

<= 128 characters

address

User’s street address.

string

<= 128 characters

zip

User’s postal/ZIP code.

string

<= 128 characters

blocked_domains

List of domains to block for this user.

Array<string>

allowed_ips

List of source IP addresses allowed for this user. The maximum list size is configured per deployment.

Array<string>

connection_limit

Maximum number of concurrent connections allowed for the user.

integer

>= -1 <= 1000000

is_reseller

Whether the user should have reseller privileges. Only superusers can create resellers.

boolean

is_top_level

Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.

boolean

data

integer

package_id

ProxyRequest package UUID to assign to the user. Headless integrations resolve it from their local product mapping.

string format: uuid

package_connection_limit

Connection limit for the initially assigned sub-user package only. Use -1 for package settings. Requires package_id and positive data; cannot be combined with connection_limit or is_top_level=true.

integer

>= -1 <= 1000000

meta

Additional metadata for the user. Maximum 50 fields.

object

key

additional properties

Examples

example

Example request

email=developer%40example.com&username=developer&password=Correct-Horse-Battery-Staple-42&first_name=Dana&last_name=Morgan&country=us&state=state&city=los_angeles&address=address&zip=zip&blocked_domains=blocked.example&allowed_ips=198.51.100.25&connection_limit=1&is_reseller=false&is_top_level=false&data=1073741824&package_id=550e8400-e29b-41d4-a716-446655440002&package_connection_limit=1

Fields accepted when a reseller or administrator creates a customer account.

object

email

User’s email address. Must be unique if provided.

string format: email

username

required

Unique username for the account. Must be 3-128 characters.

string

>= 3 characters <= 128 characters

password

required

Account password. Must be 8-128 characters long.

string

>= 8 characters <= 128 characters

first_name

User’s first name.

string

<= 128 characters

last_name

User’s last name.

string

<= 128 characters

country

User’s country of residence.

string

<= 128 characters

state

User’s state or province.

string

<= 128 characters

city

User’s city.

string

<= 128 characters

address

User’s street address.

string

<= 128 characters

zip

User’s postal/ZIP code.

string

<= 128 characters

blocked_domains

List of domains to block for this user.

Array<string>

allowed_ips

List of source IP addresses allowed for this user. The maximum list size is configured per deployment.

Array<string>

connection_limit

Maximum number of concurrent connections allowed for the user.

integer

>= -1 <= 1000000

is_reseller

Whether the user should have reseller privileges. Only superusers can create resellers.

boolean

is_top_level

Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.

boolean

data

integer

package_id

ProxyRequest package UUID to assign to the user. Headless integrations resolve it from their local product mapping.

string format: uuid

package_connection_limit

Connection limit for the initially assigned sub-user package only. Use -1 for package settings. Requires package_id and positive data; cannot be combined with connection_limit or is_top_level=true.

integer

>= -1 <= 1000000

meta

Additional metadata for the user. Maximum 50 fields.

object

key

additional properties

Examples

example

Example request

{
  "email": "[email protected]",
  "username": "developer",
  "password": "Correct-Horse-Battery-Staple-42",
  "first_name": "Dana",
  "last_name": "Morgan",
  "country": "us",
  "state": "state",
  "city": "los_angeles",
  "address": "address",
  "zip": "zip",
  "blocked_domains": [
    "blocked.example"
  ],
  "allowed_ips": [
    "198.51.100.25"
  ],
  "connection_limit": 1,
  "is_reseller": false,
  "is_top_level": false,
  "data": 1073741824,
  "package_id": "550e8400-e29b-41d4-a716-446655440002",
  "package_connection_limit": 1,
  "meta": {}
}

Responses

201

The resource or action result was created successfully.

application/json

Customer account with contact details, security settings, package data, referral information, and managed sub-users visible to the caller.

object

required

string format: uuid

username

required

At least 3 characters. Spaces and control characters are not allowed.

string

>= 3 characters <= 150 characters

email

required

string format: email

<= 254 characters

is_reseller

Reseller

Reseller can create sub-users and manage their data.

boolean

is_marketer

Marketer

Marketer can manage marketing campaigns and view analytics.

boolean

is_superuser

Superuser status

Designates that this user has all permissions without explicitly assigning them.

boolean

date_joined

required

string format: date-time

date_joined_ts

required

Timestamp of when the user joined

integer

first_name

string

<= 150 characters

last_name

string

<= 150 characters

balance

integer

<= 2147483647

language

en - EN * de - DE * fr - FR * it - IT * ru - RU

string

Allowed values: en de fr it ru

country

string

<= 255 characters

state

string

<= 255 characters

city

string

<= 255 characters

address

string

<= 255 characters

zip

string

<= 255 characters

company_name

string

<= 255 characters

company_address

string

<= 255 characters

company_city

string

<= 255 characters

company_postal_code

string

<= 255 characters

company_country

string

<= 255 characters

company_vat_number

string

<= 255 characters

allowed_ips

required

List of IP addresses allowed for this user

Array<string>

blocked_domains

required

List of domains blocked for this user

Array<string>

connection_limit

The maximum number of concurrent connections allowed for this package.

integer

>= -1 <= 2147483647

parent_id

required

ID of the parent user (for sub-accounts)

string

sub_users

required

Number of sub-users managed by this reseller

integer

referrals

required

Number of users referred by this user

integer

referral_id

string

<= 255 characters

referral_code

required

string

referral_data_earned

required

integer

referral_data_pending

required

integer

referral_balance_pending

required

integer

referral_balance_earned

required

integer

currency

required

Currency information for the user’s transactions

object

code

required

string

symbol

required

string

coupons

required

Available coupons for this user

Array<object>

object

string

<= 36 characters

is_expired

required

boolean

is_redeemed

required

boolean

packages

required

Array<object>

object

string

<= 36 characters

name

required

Unique display name for this package shown to customers and in the admin. Residential Starter Business Pro

string

>= 2 characters <= 255 characters

alias

required

Lowercase alphanumeric identifier used internally for package resolution and proxy username routing. Cannot be changed without affecting active connections. residential01 bizpro

string

>= 2 characters <= 255 characters /^[a-z0-9]+$/

is_unlimited_data

Unlimited Data

When enabled, users on this package have no data cap. The proxy will not enforce any bandwidth limit.

boolean

targeting_options

required

object

package

required

string

split_char

required

string

value_char

required

string

continent

required

string

country

required

string

region

required

string

city

required

string

asn

required

string

isp

required

string

username

required

string

pool

required

string

location

required

string

location_format

required

string

session

required

string

session_mode_tag

required

string

session_ttl

required

string

session_ttl_format

required

integer

required

string

os_combined

required

boolean

os_split_char

required

string

os_linux

required

string

os_windows

required

string

os_ios

required

string

os_macos

required

string

os_android

required

string

connection_limit

required

integer

created

required

string format: date-time

value

required

Arbitrary coupon value

integer format: int64

>= -9223372036854776000 <= 9223372036854776000

code

required

Leaving this field empty will generate a random code.

string

is_multi_use

Multi-use

If true, coupon can be used multiple times.

boolean

is_available_to_one_time

Available for One-Time Purchases

If true, coupon can not be used for one-time package tiers.

boolean

type

required

free_data - Free Data * monetary - Money * percentage - Percentage

string

Allowed values: free_data monetary percentage

limit

Number of times coupon can be used

integer

>= -2147483648 <= 2147483647

valid_until

Leave empty for coupons that never expire

string format: date-time

nullable

marketer

The marketer who owns this coupon. Required if is_marketer is true.

string format: uuid

nullable

user

required

The user who created this coupon.

string format: uuid

nullable

orders

required

The user’s package orders, including inactive orders. Each order contains its own data allowance, usage, ledgers, and proxy credentials. An empty list means the user has no orders.

Array<object>

object

string

<= 36 characters

connection_limit

required

integer

fulfillment_kind

required

string

rental_status

required

string

nullable

is_auto_renewal

required

boolean

auto_renewal_percentage

Auto Renewal Threshold (%)

When this percentage of the data allowance has been consumed, the order is automatically renewed if the user has sufficient balance. Set to 0 to disable auto-renewal. 80 → renew when 80% of data is used

integer

<= 70

auto_renewal_data

Auto Renewal Data (GB)

Amount of data in GB to add when auto-renewal is triggered. Set to 0 to use the package default.

integer

<= 10000

package

required

object

string

<= 36 characters

name

required

Unique display name for this package shown to customers and in the admin. Residential Starter Business Pro

string

>= 2 characters <= 255 characters

alias

required

Lowercase alphanumeric identifier used internally for package resolution and proxy username routing. Cannot be changed without affecting active connections. residential01 bizpro

string

>= 2 characters <= 255 characters /^[a-z0-9]+$/

is_unlimited_data

Unlimited Data

When enabled, users on this package have no data cap. The proxy will not enforce any bandwidth limit.

boolean

targeting_options

required

object

package

required

string

split_char

required

string

value_char

required

string

continent

required

string

country

required

string

region

required

string

city

required

string

asn

required

string

isp

required

string

username

required

string

pool

required

string

location

required

string

location_format

required

string

session

required

string

session_mode_tag

required

string

session_ttl

required

string

session_ttl_format

required

integer

required

string

os_combined

required

boolean

os_split_char

required

string

os_linux

required

string

os_windows

required

string

os_ios

required

string

os_macos

required

string

os_android

required

string

connection_limit

required

integer

proxy_password

Password used by the customer to authenticate proxy connections. Auto-generated by default — change only if a custom value is needed. Must be between 4 and 64 characters.

string

<= 64 characters

proxy_password_reset

Password Last Changed

Timestamp of the last proxy password change. Read-only — updated automatically whenever the password is rotated.

string format: date-time

nullable

pools

Private proxy pools assigned to this order. Pools restrict which proxy IPs are available to this customer. Leave blank to use the full provider pool.

Array<string>

data

Data Allowance (bytes)

Total data allowance for this order in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB

integer format: int64

<= 1000000000000000

data_remaining

required

Integer bytes. Root order: sum of usable ledger balances, not data minus data_spent. Virtual child order: max(data - data_spent, 0), a personal quota that does not guarantee the parent still has usable data.

integer

data_spent

required

Integer bytes. Root order: its own usage plus usage of existing linked child orders, including inactive ones. Deleted child orders are excluded. Child order: its own usage.

integer format: int64

ledgers

required

Usable, non-expired ledger balances for a purchased root order; empty for a virtual child order using its parent’s pool. Not a complete history. Array position does not identify the active ledger or spending order.

Array<object>

A purchased data bucket, not a complete transaction history. Finite purchases with an expiration have separate buckets. Compatible non-expiring top-ups and unlimited packages may reuse an existing bucket.

object

required

string

data

required

Data Amount (bytes)

Total data allocated to this ledger entry in bytes. 1073741824 = 1 GiB 10737418240 = 10 GiB

integer

data_remaining

required

Remaining Data (bytes)

Bytes still available for consumption from this ledger entry. Decremented in FIFO order as the customer uses the proxy. When this reaches zero the entry is exhausted.

integer

expires

required

Expiration Date

Date and time when this ledger entry expires and any remaining data is forfeited. Leave blank for entries that do not expire.

string format: date-time

nullable

updated

required

string format: date-time

created

required

string format: date-time

latest_data_top_up

Latest Top-up (bytes)

Amount of data added to this order in bytes during the most recent top-up.

integer format: int64

>= -9223372036854776000 <= 9223372036854776000

latest_data_top_up_date

Latest Top-up Date

Timestamp of the most recent data top-up, set when an invoice is fulfilled.

string format: date-time

nullable

data_updated

required

Last Used

string format: date-time

updated

required

string format: date-time

created

required

string format: date-time

Examples

CreatedUser

Created user

{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "email": "[email protected]",
  "username": "developer",
  "first_name": "Dana",
  "last_name": "Morgan",
  "is_reseller": false,
  "orders": []
}

Headers

Idempotency-Replayed

string

Allowed values: true

True when the response was replayed from a prior request.

ETag

string

Strong entity tag for optimistic concurrency control.

400

The request is malformed or violates a business rule.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

ValidationError

Validation error

{
  "non_field_errors": [
    "The request could not be processed."
  ]
}

Headers

Content-Language

string

Language used for human-readable errors.

401

Authentication credentials are missing, expired, or invalid.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

AuthenticationRequired

Authentication required

{
  "detail": "Authentication credentials were not provided."
}

Headers

Content-Language

string

Language used for human-readable errors.

403

The authenticated account cannot perform this operation.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Examples

PermissionDenied

Permission denied

{
  "detail": "You do not have permission to perform this action."
}

Headers

Content-Language

string

Language used for human-readable errors.

409

The idempotency key is in progress or was reused for a different request.

application/json

Validation and API error payload. Field names may be added dynamically; field errors are returned as arrays of human-readable messages.

object

detail

string

non_field_errors

Array<string>

key

additional properties

One of:

string
Array<string>

string

Example^generated

{
  "detail": "example",
  "non_field_errors": [
    "example"
  ]
}

Headers

Content-Language

string

Language used for human-readable errors.

Create a customer account

Authorizations

Parameters

Header Parameters

Examples

Request Bodyrequired

Examples

Examples

Examples

Responses

201

Examples

Headers

400

Examples

Headers

401

Examples

Headers

403

Examples

Headers

409

Examplegenerated

Headers

Request Body^required

Example^generated