Skip to content

Create a residential sub-user

POST
/proxies/residential/subusers
curl --request POST \
--url https://api.ltesocks.io/v2/proxies/residential/subusers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: example' \
--data '{ "login": "customer01", "traffic_bytes": 10737418, "package_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Requires an active linked top-level Master or Regular account and enabled residential sub-user management. Slave accounts cannot manage children. Send Authorization: Bearer . Token ability: proxy.residential.subusers.store (or *). Send the login suffix and a positive initial traffic allocation. The server prefixes the parent login and generates email. Do not send email, first_name or last_name. Allocation is subject to the parent’s available traffic and the 100 TiB total quota limit.

Idempotency-Key
required
string
>= 1 characters <= 255 characters

Key identifying this mutation. Use a new key for a new operation and reuse the same key and payload when retrying. A UUID is recommended; the API accepts any non-empty string up to 255 characters.

Media typeapplication/json

Only a login suffix and initial traffic are required. Do not send email, first_name or last_name; supplying any of these fields is rejected. The parent comes from the bearer token.

object
login
required

Login suffix. The full login is {parent_login}_{login}; email is generated automatically.

string
>= 4 characters <= 50 characters /^[A-Za-z0-9_-]+$/
Example
customer01
traffic_bytes
required

Positive initial allocation in bytes. 10737418 bytes is approximately 0.01 GiB. The quota limit is 100 TiB (labelled 100 TB in the panels).

integer format: int64
>= 1 <= 109951162777600
Example
10737418
package_id

Optional configured residential package UUID. Omit or send null to use the active package. A different package is rejected.

string format: uuid
nullable

Create a residential sub-user succeeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
data
required
object
id

LTESocks child UUID used in management URLs.

string format: uuid
login
string
email
string
nullable
first_name
string
nullable
last_name
string
nullable
status
string
package_id
string format: uuid
traffic_bytes

Allocated quota in bytes.

integer format: int64
nullable
used_bytes

Consumed traffic in bytes.

integer format: int64
nullable
remaining_bytes

Remaining traffic in bytes.

integer format: int64
nullable
allowed_ips
Array<string>
blocked_domains
Array<string>
created_at

Creation timestamp.

string
nullable
Examples
Exampleresponse
{
"success": true,
"code": 201,
"data": {
"id": "11111111-1111-4111-8111-111111111111",
"login": "parent_customer01",
"email": "parent_customer01@example.test",
"first_name": null,
"last_name": null,
"status": "active",
"package_id": "22222222-2222-4222-8222-222222222222",
"traffic_bytes": 1073741824,
"used_bytes": 0,
"remaining_bytes": 1073741824,
"allowed_ips": [],
"blocked_domains": [],
"created_at": "2026-10-21T12:00:00Z"
}
}

Missing or invalid bearer token.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Inactive or unsupported account, insufficient token ability, or child ownership denied.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Sub-user or linked residential account not found, or residential sub-user management is disabled.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Conflicting operation or duplicate user.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Invalid input, insufficient available traffic, incompatible package, or quota limit exceeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Request rate limit exceeded.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Internal service error.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Residential service failed or its result could not be read.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}

Residential service temporarily unavailable.

Media typeapplication/json
object
success
required
boolean
code
required
integer
message
required
string
errors

Field validation errors, when available.

object
key
additional properties
Array<string>
Example
{
"success": false,
"code": 422,
"message": "Data amount must be greater than zero."
}