Sub-Users

A sub-user is a gateway account belonging to one of your customers: a username, a password, and a data limit drawn from your pool. Creating one debits your unassigned data immediately.

Creating a sub-user

POST /reseller/users

cURL

curl -X POST https://api.roundproxies.com/reseller/users \
  -H "x-reseller-key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{"dataGB": 5, "username": "acme_customer1"}'

Request Fields

Field	Required	Rules
`dataGB`	yes	Whole GB, 1–10,000
`username`	no	6–32 chars, lowercase `a-z 0-9 _ -`. Auto-generated if omitted. Usernames are globally unique.
`password`	no	8–64 chars, `a-z A-Z 0-9 _ -`. Auto-generated if omitted.

200 OK

{
  "message": "Sub-user created",
  "subUser": {
    "username": "acme_customer1",
    "password": "9f8e7d6c5b4a...",
    "dataBytes": 5368709120,
    "dataGB": 5,
    "createdAt": "..."
  },
  "remainingBytes": 59055800320
}

Credentials stay retrievable from the list and detail endpoints. This is not a one-time reveal, so you don’t have to store the password yourself.

Errors

Status	Meaning
`409`	Username already taken — pick another.
`502`	The gateway rejected the account. Nothing was charged — retry safely.

There is no “not enough data” error. The pool is tracked, not enforced — assigning more than you’ve purchased just drives remainingBytes negative.

Listing your sub-users

GET /reseller/users

Paginated, with stored credentials and assigned totals. Accepts page and limit (default 25, max 100).

cURL

curl "https://api.roundproxies.com/reseller/users?page=1&limit=25" \
  -H "x-reseller-key: $KEY"

Add includeUsage=true to include each sub-user’s live consumption from the gateway. This costs one gateway lookup per row, so the request gets slower as the page grows — use it for dashboard views, not high-frequency polling. 200 OK

{
  "subUsers": [
    {
      "username": "acme_customer1",
      "password": "...",
      "dataBytes": 5368709120,
      "dataGB": 5,
      "createdAt": "...",
      "usage": {
        "used": "1.2 GB",
        "total": "5 GB",
        "rawUsed": 1288490188,
        "rawTotal": 5368709120
      }
    }
  ],
  "total": 8,
  "page": 1,
  "limit": 25
}

If a live lookup fails for one row, that row comes back with "usage": null and a usageError note rather than failing the whole request. Handle null usage as “unknown”, not as zero.

Checking one sub-user

GET /reseller/users/:username

A single sub-user with live usage — this is the endpoint for “how much data has this customer consumed?”

cURL

curl https://api.roundproxies.com/reseller/users/acme_customer1 \
  -H "x-reseller-key: $KEY"

200 OK

{
  "subUser": {
    "username": "acme_customer1",
    "password": "...",
    "dataBytes": 5368709120,
    "dataGB": 5
  },
  "usage": {
    "used": "1.2 GB",
    "total": "5 GB",
    "rawUsed": 1288490188,
    "rawTotal": 5368709120
  }
}

If the gateway is unreachable the credentials still return, with "usage": null and a usageError note. When rawUsed >= rawTotal the account is exhausted and stops working. Top it up to reactivate it.

Adjusting a sub-user’s data

POST /reseller/users/:username/data

Takes a signed GB delta. Positive tops up, negative takes unconsumed data back.

cURL

curl -X POST https://api.roundproxies.com/reseller/users/acme_customer1/data \
  -H "x-reseller-key: $KEY" \
  -H "Content-Type: application/json" \
  -d '{"dataGB": 10}'

Direction	Effect
`{"dataGB": 10}`	Debits your unassigned allocation and extends the account upstream
`{"dataGB": -3}`	Reduces the assignment, shrinks the upstream quota by the same amount, and returns the bytes to your unassigned allocation

Rules:

Range is ±10,000 GB. Zero is rejected.
An assignment can never go below zero — removing more than is currently assigned is a 400.
Removal only reclaims unconsumed data. Data your customer already used is gone.

200 OK

{
  "message": "Added 10GB",
  "username": "acme_customer1",
  "dataBytes": 16106127360,
  "remainingBytes": 42949672960
}

A 502 means nothing was charged and a retry is safe.

Deleting a sub-user

DELETE /reseller/users/:username

Ends a customer’s access and reclaims what they didn’t use.

cURL

curl -X DELETE https://api.roundproxies.com/reseller/users/acme_customer1 \
  -H "x-reseller-key: $KEY"

200 OK

{
  "username": "acme_customer1",
  "refundedBytes": 4080218931,
  "refundedGB": 3.8
}

What happens, in order:

The account’s unconsumed quota is drained upstream — the credentials stop working.
The unconsumed portion is refunded to your unassigned allocation.
The record is removed from your account.

Consumption history for your account is preserved, so deleting a sub-user doesn’t erase it from your usage history.

Deletion is irreversible. To give the same customer access again, create a new sub-user — and prefer a fresh username, since the old account still exists upstream in a drained state.

If the gateway cannot be reached, the deletion aborts with a 502 and nothing changes — retry later.

Getting Started

Residential Proxies

ISP Proxies

Datacenter Proxies

Reseller

Reseller API

Creating a sub-user

POST /reseller/users

Request Fields

Errors

Listing your sub-users

GET /reseller/users

Checking one sub-user

GET /reseller/users/:username

Adjusting a sub-user’s data

POST /reseller/users/:username/data

Deleting a sub-user

DELETE /reseller/users/:username

​Creating a sub-user

​POST /reseller/users

​Request Fields

​Errors

​Listing your sub-users

​GET /reseller/users

​Checking one sub-user

​GET /reseller/users/:username

​Adjusting a sub-user’s data

​POST /reseller/users/:username/data

​Deleting a sub-user

​DELETE /reseller/users/:username

Creating a sub-user

POST /reseller/users

Request Fields

Errors

Listing your sub-users

GET /reseller/users

Checking one sub-user

GET /reseller/users/:username

Adjusting a sub-user’s data

POST /reseller/users/:username/data

Deleting a sub-user

DELETE /reseller/users/:username