Users

SDK Reference · Resource

Users

Manage users and sub-users that belong to the current account.

list()create()get()update()delete()addData()resetData()subtractData()listOrders()resetPassword()

method

list()

List users in the current account

Returns users visible to the caller. Resellers see their sub-users, regular customers see only themselves, and administrators can see all users.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.list(options: UsersListOptions = {}): Promise<UsersListResponse>

Parameters

Name	Type	Requirement	Description
email	string	Optional	—
id	string	Optional	—
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Optional	Filters the visible user list to accounts that have at least one stored order for this package UUID. Orders are matched regardless of whether they are active or expired; this filter never expands the caller's normal account scope.
search	string	Optional	Case-insensitive partial search across user fields: `email`, `username`, `first_name`, and `last_name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
username	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.users.list();

Returns

PaginatedUserList

The operation completed successfully.

typePaginatedUserList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

User[]

Required

—

typeUser43fields

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

FieldTypeRequirementDescription

id

string

Required

—

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

string

Required

—

is_reseller

boolean

Optional

Reseller can create sub-users and manage their data.

is_marketer

boolean

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

boolean

Optional

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

date_joined

string

Required

—

date_joined_ts

number

Required

Timestamp of when the user joined

first_name

string

Optional

—

last_name

string

Optional

—

balance

number

Optional

—

language

LanguageEnum

Optional

—

enumLanguageEnum0fields

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

No fields.

country

string

Optional

—

state

string

Optional

—

city

string

Optional

—

address

string

Optional

—

zip

string

Optional

—

company_name

string

Optional

—

company_address

string

Optional

—

company_city

string

Optional

—

company_postal_code

string

Optional

—

company_country

string

Optional

—

company_vat_number

string

Optional

—

allowed_ips

string[]

Required

List of IP addresses allowed for this user

blocked_domains

string[]

Required

List of domains blocked for this user

connection_limit

number

Optional

The maximum number of concurrent connections allowed for this package.

parent_id

string

Required

ID of the parent user (for sub-accounts)

sub_users

number

Required

Number of sub-users managed by this reseller

referrals

number

Required

Number of users referred by this user

referral_id

string

Optional

—

referral_code

string

Required

—

referral_data_earned

number

Required

—

referral_data_pending

number

Required

—

referral_balance_pending

number

Required

—

referral_balance_earned

number

Required

—

currency

UserCurrency

Required

Currency information for the user's transactions

typeUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

—

symbol

string

Required

—

coupons

CouponShort[]

Required

Available coupons for this user

typeCouponShort14fields

FieldTypeRequirementDescription

id

string

Optional

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

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

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

Order[]

Optional

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.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.listWithResponse(options): Promise<ApiResponse<UsersListResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.list(*, email: str | Unset=UNSET, id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID | Unset=UNSET, search: str | Unset=UNSET, username: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedUserList

Asyncawait async_client.users.list(*, email: str | Unset=UNSET, id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID | Unset=UNSET, search: str | Unset=UNSET, username: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedUserList

Parameters

Name	Type	Requirement	Description
email	str	Optional	—
id	str	Optional	—
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
package_id	str	Optional	Filters the visible user list to accounts that have at least one stored order for this package UUID. Orders are matched regardless of whether they are active or expired; this filter never expands the caller's normal account scope.
search	str	Optional	Case-insensitive partial search across user fields: `email`, `username`, `first_name`, and `last_name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
username	str	Optional	—
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.users.list()

Async example

result = await async_client.users.list()

Returns

PaginatedUserList

The operation completed successfully.

classPaginatedUserList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[User]

Required

—

classUser43fields

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

FieldTypeRequirementDescription

id

UUID

Required

—

username

str

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

str

Required

—

date_joined

datetime.datetime

Required

—

date_joined_ts

int

Required

Timestamp of when the user joined

allowed_ips

list[str]

Required

List of IP addresses allowed for this user

blocked_domains

list[str]

Required

List of domains blocked for this user

parent_id

str

Required

ID of the parent user (for sub-accounts)

sub_users

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referral_code

str

Required

—

referral_data_earned

int

Required

—

referral_data_pending

int

Required

—

referral_balance_pending

int

Required

—

referral_balance_earned

int

Required

—

currency

UserCurrency

Required

—

classUserCurrency2fields

FieldTypeRequirementDescription

code

str

Required

—

symbol

str

Required

—

coupons

list[CouponShort]

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

created

datetime.datetime

Required

—

value

int

Required

Arbitrary coupon value

code

str

Required

Leaving this field empty will generate a random code.

type_

CouponTypeEnum

Required

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

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

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

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

is_reseller

bool

Optional

Reseller can create sub-users and manage their data.

is_marketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

bool

Optional

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

first_name

str

Optional

—

last_name

str

Optional

—

balance

int

Optional

—

language

LanguageEnum

Optional

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

enumLanguageEnum0fields

No fields.

country

str

Optional

—

state

str

Optional

—

city

str

Optional

—

address

str

Optional

—

zip_

str

Optional

—

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_country

str

Optional

—

company_vat_number

str

Optional

—

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

referral_id

str

Optional

—

data

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

None | str

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

list[Order]

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.list_with_response(*, email: str | Unset=UNSET, id: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: UUID | Unset=UNSET, search: str | Unset=UNSET, username: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedUserList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->list($email = null, $id = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

Name	Type	Requirement	Description
email	string	Optional	—
id	string	Optional	—
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageId	string	Optional	Filters the visible user list to accounts that have at least one stored order for this package UUID. Orders are matched regardless of whether they are active or expired; this filter never expands the caller's normal account scope.
search	string	Optional	Case-insensitive partial search across user fields: `email`, `username`, `first_name`, and `last_name`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
username	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->users()->list();

Returns

PaginatedUserList

The operation completed successfully.

classPaginatedUserList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[User[]](User.md)

Required

|

classUser43fields

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

FieldTypeRequirementDescription

id

string

Required

| [readonly]

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore. |

email

string

Required

|

isReseller

bool

Optional

Reseller can create sub-users and manage their data.

isMarketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

isSuperuser

bool

Optional

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

dateJoined

DateTime

Required

| [readonly]

dateJoinedTs

int

Required

Timestamp of when the user joined

firstName

string

Required

| [optional]

lastName

string

Required

| [optional]

balance

int

Required

| [optional]

language

LanguageEnum

Required

| [optional]

enumLanguageEnum0fields

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

No fields.

country

string

Required

| [optional]

state

string

Required

| [optional]

city

string

Required

| [optional]

address

string

Required

| [optional]

zip

string

Required

| [optional]

companyName

string

Required

| [optional]

companyAddress

string

Required

| [optional]

companyCity

string

Required

| [optional]

companyPostalCode

string

Required

| [optional]

companyCountry

string

Required

| [optional]

companyVatNumber

string

Required

| [optional]

allowedIps

array<string>

Required

List of IP addresses allowed for this user

blockedDomains

array<string>

Required

List of domains blocked for this user

connectionLimit

int

Optional

The maximum number of concurrent connections allowed for this package.

parentId

string

Required

ID of the parent user (for sub-accounts)

subUsers

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referralId

string

Required

| [optional]

referralCode

string

Required

| [readonly]

referralDataEarned

int

Required

| [readonly]

referralDataPending

int

Required

| [readonly]

referralBalancePending

int

Required

| [readonly]

referralBalanceEarned

int

Required

| [readonly]

currency

UserCurrency

Required

Currency information for the user's transactions

classUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

|

symbol

string

Required

|

coupons

[CouponShort[]](CouponShort.md)

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

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

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataSpent

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataUpdated

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPassword

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPasswordReset

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

[Order[]](Order.md)

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->listWithResponse($email = null, $id = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->listWithHttpInfo($email = null, $id = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->listAsync($email = null, $id = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->listAsyncWithHttpInfo($email = null, $id = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->listRequest($email = null, $id = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Builds the PSR-7 request without sending it.

method

create()

Create a customer account

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.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.create(options: UsersCreateOptions): Promise<UsersCreateResponse>

Parameters

Name	Type	Requirement	Description
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	UserCreateRequest	Required	—

Example

const result = await client.users.create({
  body: {
    "username": "{username}",
    "password": "Correct-Horse-Battery-Staple-42"
  }
});

Returns

User

The resource or action result was created successfully.

typeUser43fields

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

FieldTypeRequirementDescription

id

string

Required

—

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

string

Required

—

is_reseller

boolean

Optional

Reseller can create sub-users and manage their data.

is_marketer

boolean

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

boolean

Optional

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

date_joined

string

Required

—

date_joined_ts

number

Required

Timestamp of when the user joined

first_name

string

Optional

—

last_name

string

Optional

—

balance

number

Optional

—

language

LanguageEnum

Optional

—

enumLanguageEnum0fields

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

No fields.

country

string

Optional

—

state

string

Optional

—

city

string

Optional

—

address

string

Optional

—

zip

string

Optional

—

company_name

string

Optional

—

company_address

string

Optional

—

company_city

string

Optional

—

company_postal_code

string

Optional

—

company_country

string

Optional

—

company_vat_number

string

Optional

—

allowed_ips

string[]

Required

List of IP addresses allowed for this user

blocked_domains

string[]

Required

List of domains blocked for this user

connection_limit

number

Optional

The maximum number of concurrent connections allowed for this package.

parent_id

string

Required

ID of the parent user (for sub-accounts)

sub_users

number

Required

Number of sub-users managed by this reseller

referrals

number

Required

Number of users referred by this user

referral_id

string

Optional

—

referral_code

string

Required

—

referral_data_earned

number

Required

—

referral_data_pending

number

Required

—

referral_balance_pending

number

Required

—

referral_balance_earned

number

Required

—

currency

UserCurrency

Required

Currency information for the user's transactions

typeUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

—

symbol

string

Required

—

coupons

CouponShort[]

Required

Available coupons for this user

typeCouponShort14fields

FieldTypeRequirementDescription

id

string

Optional

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

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

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

Order[]

Optional

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.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "conflict"The operation conflicts with the current resource or idempotency state.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.createWithResponse(options): Promise<ApiResponse<UsersCreateResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.create(*, body: UserCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> User

Asyncawait async_client.users.create(*, body: UserCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> User

Parameters

Name	Type	Requirement	Description
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	UserCreateRequest	Required	—

Example

result = client.users.create(
        body=models.UserCreateRequest.from_dict({'username': '{username}', 'password': 'Correct-Horse-Battery-Staple-42'}),
    )

Async example

result = await async_client.users.create(
        body=models.UserCreateRequest.from_dict({'username': '{username}', 'password': 'Correct-Horse-Battery-Staple-42'}),
    )

Returns

User

The resource or action result was created successfully.

classUser43fields

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

FieldTypeRequirementDescription

id

UUID

Required

—

username

str

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

str

Required

—

date_joined

datetime.datetime

Required

—

date_joined_ts

int

Required

Timestamp of when the user joined

allowed_ips

list[str]

Required

List of IP addresses allowed for this user

blocked_domains

list[str]

Required

List of domains blocked for this user

parent_id

str

Required

ID of the parent user (for sub-accounts)

sub_users

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referral_code

str

Required

—

referral_data_earned

int

Required

—

referral_data_pending

int

Required

—

referral_balance_pending

int

Required

—

referral_balance_earned

int

Required

—

currency

UserCurrency

Required

—

classUserCurrency2fields

FieldTypeRequirementDescription

code

str

Required

—

symbol

str

Required

—

coupons

list[CouponShort]

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

created

datetime.datetime

Required

—

value

int

Required

Arbitrary coupon value

code

str

Required

Leaving this field empty will generate a random code.

type_

CouponTypeEnum

Required

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

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

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

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

is_reseller

bool

Optional

Reseller can create sub-users and manage their data.

is_marketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

bool

Optional

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

first_name

str

Optional

—

last_name

str

Optional

—

balance

int

Optional

—

language

LanguageEnum

Optional

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

enumLanguageEnum0fields

No fields.

country

str

Optional

—

state

str

Optional

—

city

str

Optional

—

address

str

Optional

—

zip_

str

Optional

—

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_country

str

Optional

—

company_vat_number

str

Optional

—

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

referral_id

str

Optional

—

data

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

None | str

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

list[Order]

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.create_with_response(*, body: UserCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[User]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->create($userCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

Parameters

Name	Type	Requirement	Description
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
userCreateRequest	UserCreateRequest	Required	—

Example

$result = $client->users()->create(
    userCreateRequest: new Dto\UserCreateRequest([
        'username' => '{username}',
        'password' => 'Correct-Horse-Battery-Staple-42',
    ]),
);

Returns

User

The resource or action result was created successfully.

classUser43fields

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

FieldTypeRequirementDescription

id

string

Required

| [readonly]

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore. |

email

string

Required

|

isReseller

bool

Optional

Reseller can create sub-users and manage their data.

isMarketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

isSuperuser

bool

Optional

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

dateJoined

DateTime

Required

| [readonly]

dateJoinedTs

int

Required

Timestamp of when the user joined

firstName

string

Required

| [optional]

lastName

string

Required

| [optional]

balance

int

Required

| [optional]

language

LanguageEnum

Required

| [optional]

enumLanguageEnum0fields

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

No fields.

country

string

Required

| [optional]

state

string

Required

| [optional]

city

string

Required

| [optional]

address

string

Required

| [optional]

zip

string

Required

| [optional]

companyName

string

Required

| [optional]

companyAddress

string

Required

| [optional]

companyCity

string

Required

| [optional]

companyPostalCode

string

Required

| [optional]

companyCountry

string

Required

| [optional]

companyVatNumber

string

Required

| [optional]

allowedIps

array<string>

Required

List of IP addresses allowed for this user

blockedDomains

array<string>

Required

List of domains blocked for this user

connectionLimit

int

Optional

The maximum number of concurrent connections allowed for this package.

parentId

string

Required

ID of the parent user (for sub-accounts)

subUsers

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referralId

string

Required

| [optional]

referralCode

string

Required

| [readonly]

referralDataEarned

int

Required

| [readonly]

referralDataPending

int

Required

| [readonly]

referralBalancePending

int

Required

| [readonly]

referralBalanceEarned

int

Required

| [readonly]

currency

UserCurrency

Required

Currency information for the user's transactions

classUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

|

symbol

string

Required

|

coupons

[CouponShort[]](CouponShort.md)

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

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

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataSpent

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataUpdated

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPassword

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPasswordReset

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

[Order[]](Order.md)

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ConflictThe operation conflicts with the current resource or idempotency state.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->createWithResponse($userCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->createWithHttpInfo($userCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->createAsync($userCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->createAsyncWithHttpInfo($userCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->createRequest($userCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Builds the PSR-7 request without sending it.

method

get()

Get a user

Returns a user that is visible within the caller's account scope.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.get(options: UsersGetOptions): Promise<UsersGetResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.users.get({
  id: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

User

The operation completed successfully.

typeUser43fields

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

FieldTypeRequirementDescription

id

string

Required

—

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

string

Required

—

is_reseller

boolean

Optional

Reseller can create sub-users and manage their data.

is_marketer

boolean

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

boolean

Optional

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

date_joined

string

Required

—

date_joined_ts

number

Required

Timestamp of when the user joined

first_name

string

Optional

—

last_name

string

Optional

—

balance

number

Optional

—

language

LanguageEnum

Optional

—

enumLanguageEnum0fields

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

No fields.

country

string

Optional

—

state

string

Optional

—

city

string

Optional

—

address

string

Optional

—

zip

string

Optional

—

company_name

string

Optional

—

company_address

string

Optional

—

company_city

string

Optional

—

company_postal_code

string

Optional

—

company_country

string

Optional

—

company_vat_number

string

Optional

—

allowed_ips

string[]

Required

List of IP addresses allowed for this user

blocked_domains

string[]

Required

List of domains blocked for this user

connection_limit

number

Optional

The maximum number of concurrent connections allowed for this package.

parent_id

string

Required

ID of the parent user (for sub-accounts)

sub_users

number

Required

Number of sub-users managed by this reseller

referrals

number

Required

Number of users referred by this user

referral_id

string

Optional

—

referral_code

string

Required

—

referral_data_earned

number

Required

—

referral_data_pending

number

Required

—

referral_balance_pending

number

Required

—

referral_balance_earned

number

Required

—

currency

UserCurrency

Required

Currency information for the user's transactions

typeUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

—

symbol

string

Required

—

coupons

CouponShort[]

Required

Available coupons for this user

typeCouponShort14fields

FieldTypeRequirementDescription

id

string

Optional

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

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

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

Order[]

Optional

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.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.getWithResponse(options): Promise<ApiResponse<UsersGetResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.get(id: UUID, *, accept_language: str | Unset=UNSET) -> User

Asyncawait async_client.users.get(id: UUID, *, accept_language: str | Unset=UNSET) -> User

Parameters

Name	Type	Requirement	Description
id	str	Required	A UUID string identifying this user.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.users.get(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.users.get(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

User

The operation completed successfully.

classUser43fields

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

FieldTypeRequirementDescription

id

UUID

Required

—

username

str

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

str

Required

—

date_joined

datetime.datetime

Required

—

date_joined_ts

int

Required

Timestamp of when the user joined

allowed_ips

list[str]

Required

List of IP addresses allowed for this user

blocked_domains

list[str]

Required

List of domains blocked for this user

parent_id

str

Required

ID of the parent user (for sub-accounts)

sub_users

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referral_code

str

Required

—

referral_data_earned

int

Required

—

referral_data_pending

int

Required

—

referral_balance_pending

int

Required

—

referral_balance_earned

int

Required

—

currency

UserCurrency

Required

—

classUserCurrency2fields

FieldTypeRequirementDescription

code

str

Required

—

symbol

str

Required

—

coupons

list[CouponShort]

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

created

datetime.datetime

Required

—

value

int

Required

Arbitrary coupon value

code

str

Required

Leaving this field empty will generate a random code.

type_

CouponTypeEnum

Required

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

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

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

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

is_reseller

bool

Optional

Reseller can create sub-users and manage their data.

is_marketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

bool

Optional

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

first_name

str

Optional

—

last_name

str

Optional

—

balance

int

Optional

—

language

LanguageEnum

Optional

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

enumLanguageEnum0fields

No fields.

country

str

Optional

—

state

str

Optional

—

city

str

Optional

—

address

str

Optional

—

zip_

str

Optional

—

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_country

str

Optional

—

company_vat_number

str

Optional

—

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

referral_id

str

Optional

—

data

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

None | str

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

list[Order]

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.get_with_response(id: UUID, *, accept_language: str | Unset=UNSET) -> ApiResponse[User]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->get($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->users()->get(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

User

The operation completed successfully.

classUser43fields

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

FieldTypeRequirementDescription

id

string

Required

| [readonly]

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore. |

email

string

Required

|

isReseller

bool

Optional

Reseller can create sub-users and manage their data.

isMarketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

isSuperuser

bool

Optional

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

dateJoined

DateTime

Required

| [readonly]

dateJoinedTs

int

Required

Timestamp of when the user joined

firstName

string

Required

| [optional]

lastName

string

Required

| [optional]

balance

int

Required

| [optional]

language

LanguageEnum

Required

| [optional]

enumLanguageEnum0fields

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

No fields.

country

string

Required

| [optional]

state

string

Required

| [optional]

city

string

Required

| [optional]

address

string

Required

| [optional]

zip

string

Required

| [optional]

companyName

string

Required

| [optional]

companyAddress

string

Required

| [optional]

companyCity

string

Required

| [optional]

companyPostalCode

string

Required

| [optional]

companyCountry

string

Required

| [optional]

companyVatNumber

string

Required

| [optional]

allowedIps

array<string>

Required

List of IP addresses allowed for this user

blockedDomains

array<string>

Required

List of domains blocked for this user

connectionLimit

int

Optional

The maximum number of concurrent connections allowed for this package.

parentId

string

Required

ID of the parent user (for sub-accounts)

subUsers

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referralId

string

Required

| [optional]

referralCode

string

Required

| [readonly]

referralDataEarned

int

Required

| [readonly]

referralDataPending

int

Required

| [readonly]

referralBalancePending

int

Required

| [readonly]

referralBalanceEarned

int

Required

| [readonly]

currency

UserCurrency

Required

Currency information for the user's transactions

classUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

|

symbol

string

Required

|

coupons

[CouponShort[]](CouponShort.md)

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

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

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataSpent

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataUpdated

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPassword

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPasswordReset

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

[Order[]](Order.md)

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->getWithResponse($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->getWithHttpInfo($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->getAsync($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->getAsyncWithHttpInfo($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->getRequest($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0])

  Builds the PSR-7 request without sending it.

method

update()

Update a user

Updates selected fields for a visible user and returns the latest account state.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.update(options: UsersUpdateOptions): Promise<UsersUpdateResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	PatchedUserUpdateRequest	Optional	—

Example

const result = await client.users.update({
  id: "550e8400-e29b-41d4-a716-446655440000",
  body: {}
});

Returns

User

The request was accepted and the updated resource is returned.

typeUser43fields

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

FieldTypeRequirementDescription

id

string

Required

—

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

string

Required

—

is_reseller

boolean

Optional

Reseller can create sub-users and manage their data.

is_marketer

boolean

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

boolean

Optional

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

date_joined

string

Required

—

date_joined_ts

number

Required

Timestamp of when the user joined

first_name

string

Optional

—

last_name

string

Optional

—

balance

number

Optional

—

language

LanguageEnum

Optional

—

enumLanguageEnum0fields

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

No fields.

country

string

Optional

—

state

string

Optional

—

city

string

Optional

—

address

string

Optional

—

zip

string

Optional

—

company_name

string

Optional

—

company_address

string

Optional

—

company_city

string

Optional

—

company_postal_code

string

Optional

—

company_country

string

Optional

—

company_vat_number

string

Optional

—

allowed_ips

string[]

Required

List of IP addresses allowed for this user

blocked_domains

string[]

Required

List of domains blocked for this user

connection_limit

number

Optional

The maximum number of concurrent connections allowed for this package.

parent_id

string

Required

ID of the parent user (for sub-accounts)

sub_users

number

Required

Number of sub-users managed by this reseller

referrals

number

Required

Number of users referred by this user

referral_id

string

Optional

—

referral_code

string

Required

—

referral_data_earned

number

Required

—

referral_data_pending

number

Required

—

referral_balance_pending

number

Required

—

referral_balance_earned

number

Required

—

currency

UserCurrency

Required

Currency information for the user's transactions

typeUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

—

symbol

string

Required

—

coupons

CouponShort[]

Required

Available coupons for this user

typeCouponShort14fields

FieldTypeRequirementDescription

id

string

Optional

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

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

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

Order[]

Optional

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.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "precondition"A required resource precondition is no longer satisfied.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.updateWithResponse(options): Promise<ApiResponse<UsersUpdateResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.update(id: UUID, *, body: PatchedUserUpdateRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> User

Asyncawait async_client.users.update(id: UUID, *, body: PatchedUserUpdateRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> User

Parameters

Name	Type	Requirement	Description
id	str	Required	A UUID string identifying this user.
if_match	str	Optional	Strong ETag from the latest representation of this resource.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	PatchedUserUpdateRequest	Optional	—

Example

result = client.users.update(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.PatchedUserUpdateRequest.from_dict({}),
    )

Async example

result = await async_client.users.update(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.PatchedUserUpdateRequest.from_dict({}),
    )

Returns

User

The request was accepted and the updated resource is returned.

classUser43fields

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

FieldTypeRequirementDescription

id

UUID

Required

—

username

str

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

str

Required

—

date_joined

datetime.datetime

Required

—

date_joined_ts

int

Required

Timestamp of when the user joined

allowed_ips

list[str]

Required

List of IP addresses allowed for this user

blocked_domains

list[str]

Required

List of domains blocked for this user

parent_id

str

Required

ID of the parent user (for sub-accounts)

sub_users

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referral_code

str

Required

—

referral_data_earned

int

Required

—

referral_data_pending

int

Required

—

referral_balance_pending

int

Required

—

referral_balance_earned

int

Required

—

currency

UserCurrency

Required

—

classUserCurrency2fields

FieldTypeRequirementDescription

code

str

Required

—

symbol

str

Required

—

coupons

list[CouponShort]

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

created

datetime.datetime

Required

—

value

int

Required

Arbitrary coupon value

code

str

Required

Leaving this field empty will generate a random code.

type_

CouponTypeEnum

Required

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

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

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

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

is_reseller

bool

Optional

Reseller can create sub-users and manage their data.

is_marketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

bool

Optional

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

first_name

str

Optional

—

last_name

str

Optional

—

balance

int

Optional

—

language

LanguageEnum

Optional

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

enumLanguageEnum0fields

No fields.

country

str

Optional

—

state

str

Optional

—

city

str

Optional

—

address

str

Optional

—

zip_

str

Optional

—

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_country

str

Optional

—

company_vat_number

str

Optional

—

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

referral_id

str

Optional

—

data

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

None | str

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

list[Order]

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.PRECONDITIONA required resource precondition is no longer satisfied.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.update_with_response(id: UUID, *, body: PatchedUserUpdateRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[User]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->update($id, $ifMatch = null, $acceptLanguage = null, $patchedUserUpdateRequest = null, string $contentType = self::contentTypes['update'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
patchedUserUpdateRequest	PatchedUserUpdateRequest	Optional	—

Example

$result = $client->users()->update(
    id: '550e8400-e29b-41d4-a716-446655440000',
    patchedUserUpdateRequest: new Dto\PatchedUserUpdateRequest([]),
);

Returns

User

The request was accepted and the updated resource is returned.

classUser43fields

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

FieldTypeRequirementDescription

id

string

Required

| [readonly]

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore. |

email

string

Required

|

isReseller

bool

Optional

Reseller can create sub-users and manage their data.

isMarketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

isSuperuser

bool

Optional

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

dateJoined

DateTime

Required

| [readonly]

dateJoinedTs

int

Required

Timestamp of when the user joined

firstName

string

Required

| [optional]

lastName

string

Required

| [optional]

balance

int

Required

| [optional]

language

LanguageEnum

Required

| [optional]

enumLanguageEnum0fields

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

No fields.

country

string

Required

| [optional]

state

string

Required

| [optional]

city

string

Required

| [optional]

address

string

Required

| [optional]

zip

string

Required

| [optional]

companyName

string

Required

| [optional]

companyAddress

string

Required

| [optional]

companyCity

string

Required

| [optional]

companyPostalCode

string

Required

| [optional]

companyCountry

string

Required

| [optional]

companyVatNumber

string

Required

| [optional]

allowedIps

array<string>

Required

List of IP addresses allowed for this user

blockedDomains

array<string>

Required

List of domains blocked for this user

connectionLimit

int

Optional

The maximum number of concurrent connections allowed for this package.

parentId

string

Required

ID of the parent user (for sub-accounts)

subUsers

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referralId

string

Required

| [optional]

referralCode

string

Required

| [readonly]

referralDataEarned

int

Required

| [readonly]

referralDataPending

int

Required

| [readonly]

referralBalancePending

int

Required

| [readonly]

referralBalanceEarned

int

Required

| [readonly]

currency

UserCurrency

Required

Currency information for the user's transactions

classUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

|

symbol

string

Required

|

coupons

[CouponShort[]](CouponShort.md)

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

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

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataSpent

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataUpdated

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPassword

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPasswordReset

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

[Order[]](Order.md)

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::PreconditionA required resource precondition is no longer satisfied.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->updateWithResponse($id, $ifMatch = null, $acceptLanguage = null, $patchedUserUpdateRequest = null, string $contentType = self::contentTypes['update'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->updateWithHttpInfo($id, $ifMatch = null, $acceptLanguage = null, $patchedUserUpdateRequest = null, string $contentType = self::contentTypes['update'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->updateAsync($id, $ifMatch = null, $acceptLanguage = null, $patchedUserUpdateRequest = null, string $contentType = self::contentTypes['update'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->updateAsyncWithHttpInfo($id, $ifMatch = null, $acceptLanguage = null, $patchedUserUpdateRequest = null, string $contentType = self::contentTypes['update'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->updateRequest($id, $ifMatch = null, $acceptLanguage = null, $patchedUserUpdateRequest = null, string $contentType = self::contentTypes['update'][0])

  Builds the PSR-7 request without sending it.

method

delete()

Delete a user

Deletes a user that the authenticated account is allowed to manage.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.delete(options: UsersDeleteOptions): Promise<UsersDeleteResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.users.delete({
  id: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

void

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "conflict"The operation conflicts with the current resource or idempotency state.
• kind: "precondition"A required resource precondition is no longer satisfied.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.deleteWithResponse(options): Promise<ApiResponse<UsersDeleteResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.delete(id: UUID, *, idempotency_key: str | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> None

Asyncawait async_client.users.delete(id: UUID, *, idempotency_key: str | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> None

Parameters

Name	Type	Requirement	Description
id	str	Required	A UUID string identifying this user.
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
if_match	str	Optional	Strong ETag from the latest representation of this resource.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.users.delete(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.users.delete(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

None

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.PRECONDITIONA required resource precondition is no longer satisfied.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.delete_with_response(id: UUID, *, idempotency_key: str | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[None]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->delete($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->users()->delete(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

void

No response body

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::ConflictThe operation conflicts with the current resource or idempotency state.
• ErrorKind::PreconditionA required resource precondition is no longer satisfied.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->deleteWithResponse($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->deleteWithHttpInfo($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->deleteAsync($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->deleteAsyncWithHttpInfo($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->deleteRequest($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Builds the PSR-7 request without sending it.

method

addData()

Add data to a sub-user order

Adds data integer bytes to a managed sub-user's virtual quota for package_id and returns the updated order. Both fields are required. The caller must own a root order for this package and the target sub-user. Creates the child order if absent; an existing independently purchased order cannot be converted by this operation. The allocation does not reserve or debit the parent's ledger, and may exceed its remaining data. Actual traffic needs both personal quota and a usable parent pool. Use Idempotency-Key to avoid granting the same quota twice.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.addData(options: UsersAddDataOptions): Promise<UsersAddDataResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	AddDataRequest	Required	—

Example

const result = await client.users.addData({
  id: "550e8400-e29b-41d4-a716-446655440000",
  body: {
    "package_id": "550e8400-e29b-41d4-a716-446655440000",
    "data": 1073741824
  }
});

Returns

Order

The request was accepted and the updated resource is returned.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "conflict"The operation conflicts with the current resource or idempotency state.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.addDataWithResponse(options): Promise<ApiResponse<UsersAddDataResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.add_data(id: UUID, *, body: AddDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Order

Asyncawait async_client.users.add_data(id: UUID, *, body: AddDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Order

Parameters

Name	Type	Requirement	Description
id	str	Required	A UUID string identifying this user.
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	AddDataRequest	Required	—

Example

result = client.users.add_data(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.AddDataRequest.from_dict({'package_id': '550e8400-e29b-41d4-a716-446655440000', 'data': 1073741824}),
    )

Async example

result = await async_client.users.add_data(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.AddDataRequest.from_dict({'package_id': '550e8400-e29b-41d4-a716-446655440000', 'data': 1073741824}),
    )

Returns

Order

The request was accepted and the updated resource is returned.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.add_data_with_response(id: UUID, *, body: AddDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[Order]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->addData($id, $addDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['addData'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
addDataRequest	AddDataRequest	Required	—

Example

$result = $client->users()->addData(
    id: '550e8400-e29b-41d4-a716-446655440000',
    addDataRequest: new Dto\AddDataRequest([
        'package_id' => '550e8400-e29b-41d4-a716-446655440000',
        'data' => 1073741824,
    ]),
);

Returns

Order

The request was accepted and the updated resource is returned.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::ConflictThe operation conflicts with the current resource or idempotency state.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->addDataWithResponse($id, $addDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['addData'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->addDataWithHttpInfo($id, $addDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['addData'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->addDataAsync($id, $addDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['addData'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->addDataAsyncWithHttpInfo($id, $addDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['addData'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->addDataRequest($id, $addDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['addData'][0])

  Builds the PSR-7 request without sending it.

method

resetData()

Reset a user's remaining data

Atomically resets remaining data to zero for package_id, including zero or negative balances. Supply package_id only; data is not accepted. System administrators may reset any user; other accounts may reset only their direct children. Purchased root orders have their ledger balances cleared; virtual child orders have their quota set to usage without changing the parent's pool. Usage history and invoices are preserved. Unlimited packages are rejected. Use Idempotency-Key for safe retries so a repeated request cannot clear a subsequent top-up.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.resetData(options: UsersResetDataOptions): Promise<UsersResetDataResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	ResetDataRequest	Required	—

Example

const result = await client.users.resetData({
  id: "550e8400-e29b-41d4-a716-446655440000",
  body: {
    "package_id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

Returns

Order

The request was accepted and the updated resource is returned.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "conflict"The operation conflicts with the current resource or idempotency state.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.resetDataWithResponse(options): Promise<ApiResponse<UsersResetDataResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.reset_data(id: UUID, *, body: ResetDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Order

Asyncawait async_client.users.reset_data(id: UUID, *, body: ResetDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Order

Parameters

Name	Type	Requirement	Description
id	str	Required	A UUID string identifying this user.
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	ResetDataRequest	Required	—

Example

result = client.users.reset_data(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.ResetDataRequest.from_dict({'package_id': '550e8400-e29b-41d4-a716-446655440000'}),
    )

Async example

result = await async_client.users.reset_data(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.ResetDataRequest.from_dict({'package_id': '550e8400-e29b-41d4-a716-446655440000'}),
    )

Returns

Order

The request was accepted and the updated resource is returned.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.reset_data_with_response(id: UUID, *, body: ResetDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[Order]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->resetData($id, $resetDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['resetData'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
resetDataRequest	ResetDataRequest	Required	—

Example

$result = $client->users()->resetData(
    id: '550e8400-e29b-41d4-a716-446655440000',
    resetDataRequest: new Dto\ResetDataRequest([
        'package_id' => '550e8400-e29b-41d4-a716-446655440000',
    ]),
);

Returns

Order

The request was accepted and the updated resource is returned.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::ConflictThe operation conflicts with the current resource or idempotency state.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->resetDataWithResponse($id, $resetDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['resetData'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->resetDataWithHttpInfo($id, $resetDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['resetData'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->resetDataAsync($id, $resetDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['resetData'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->resetDataAsyncWithHttpInfo($id, $resetDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['resetData'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->resetDataRequest($id, $resetDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['resetData'][0])

  Builds the PSR-7 request without sending it.

method

subtractData()

Subtract data from a sub-user order

Subtracts data from the assigned quota of a managed virtual child order in integer bytes for package_id. Both fields are required. This is not a refund or a transfer back into the parent's ledger, and does not erase data_spent. The amount cannot exceed the total assigned data; reducing the quota below usage can stop the child's access. An independently purchased order is not managed through this allocation endpoint. Use Idempotency-Key for safe retries.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.subtractData(options: UsersSubtractDataOptions): Promise<UsersSubtractDataResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	SubtractDataRequest	Required	—

Example

const result = await client.users.subtractData({
  id: "550e8400-e29b-41d4-a716-446655440000",
  body: {
    "package_id": "550e8400-e29b-41d4-a716-446655440000",
    "data": 1073741824
  }
});

Returns

Order

The request was accepted and the updated resource is returned.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "conflict"The operation conflicts with the current resource or idempotency state.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.subtractDataWithResponse(options): Promise<ApiResponse<UsersSubtractDataResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.subtract_data(id: UUID, *, body: SubtractDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Order

Asyncawait async_client.users.subtract_data(id: UUID, *, body: SubtractDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Order

Parameters

Name	Type	Requirement	Description
id	str	Required	A UUID string identifying this user.
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	SubtractDataRequest	Required	—

Example

result = client.users.subtract_data(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.SubtractDataRequest.from_dict({'package_id': '550e8400-e29b-41d4-a716-446655440000', 'data': 1073741824}),
    )

Async example

result = await async_client.users.subtract_data(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.SubtractDataRequest.from_dict({'package_id': '550e8400-e29b-41d4-a716-446655440000', 'data': 1073741824}),
    )

Returns

Order

The request was accepted and the updated resource is returned.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.subtract_data_with_response(id: UUID, *, body: SubtractDataRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[Order]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->subtractData($id, $subtractDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['subtractData'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
subtractDataRequest	SubtractDataRequest	Required	—

Example

$result = $client->users()->subtractData(
    id: '550e8400-e29b-41d4-a716-446655440000',
    subtractDataRequest: new Dto\SubtractDataRequest([
        'package_id' => '550e8400-e29b-41d4-a716-446655440000',
        'data' => 1073741824,
    ]),
);

Returns

Order

The request was accepted and the updated resource is returned.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::ConflictThe operation conflicts with the current resource or idempotency state.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->subtractDataWithResponse($id, $subtractDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['subtractData'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->subtractDataWithHttpInfo($id, $subtractDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['subtractData'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->subtractDataAsync($id, $subtractDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['subtractData'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->subtractDataAsyncWithHttpInfo($id, $subtractDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['subtractData'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->subtractDataRequest($id, $subtractDataRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['subtractData'][0])

  Builds the PSR-7 request without sending it.

method

listOrders()

List a sub-user's orders

Returns the selected user's package orders, including inactive orders. A user may have a purchased root order with its own ledgers or a virtual child order whose quota uses its parent's pool. User ownership and order ownership are different: being a sub-user does not imply shared-pool accounting.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.listOrders(options: UsersListOrdersOptions): Promise<UsersListOrdersResponse>

Parameters

Name	Type	Requirement	Description
email	string	Optional	—
idPath	string	Required	A UUID string identifying this user.
idQuery	string	Optional	—
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
username	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.users.listOrders({
  idPath: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

PaginatedOrderList

The operation completed successfully.

typePaginatedOrderList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

Order[]

Required

—

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.listOrdersWithResponse(options): Promise<ApiResponse<UsersListOrdersResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.list_orders(id_path: UUID, *, email: str | Unset=UNSET, id_query: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, username: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedOrderList

Asyncawait async_client.users.list_orders(id_path: UUID, *, email: str | Unset=UNSET, id_query: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, username: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedOrderList

Parameters

Name	Type	Requirement	Description
email	str	Optional	—
id_path	str	Required	A UUID string identifying this user.
id_query	str	Optional	—
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
username	str	Optional	—
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.users.list_orders(
        id_path='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.users.list_orders(
        id_path='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

PaginatedOrderList

The operation completed successfully.

classPaginatedOrderList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[Order]

Required

—

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.list_orders_with_response(id_path: UUID, *, email: str | Unset=UNSET, id_query: UUID | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, username: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedOrderList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->listOrders($id, $email = null, $id2 = null, $limit = null, $offset = null, $ordering = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['listOrders'][0])

Parameters

Name	Type	Requirement	Description
email	string	Optional	—
id	string	Required	A UUID string identifying this user.
id2	string	Optional	—
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
username	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->users()->listOrders(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

PaginatedOrderList

The operation completed successfully.

classPaginatedOrderList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[Order[]](Order.md)

Required

|

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->listOrdersWithResponse($id, $email = null, $id2 = null, $limit = null, $offset = null, $ordering = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['listOrders'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->listOrdersWithHttpInfo($id, $email = null, $id2 = null, $limit = null, $offset = null, $ordering = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['listOrders'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->listOrdersAsync($id, $email = null, $id2 = null, $limit = null, $offset = null, $ordering = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['listOrders'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->listOrdersAsyncWithHttpInfo($id, $email = null, $id2 = null, $limit = null, $offset = null, $ordering = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['listOrders'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->listOrdersRequest($id, $email = null, $id2 = null, $limit = null, $offset = null, $ordering = null, $username = null, $acceptLanguage = null, string $contentType = self::contentTypes['listOrders'][0])

  Builds the PSR-7 request without sending it.

method

resetPassword()

Rotate a sub-user proxy password

Rotates the proxy password for the selected user's package order. Send package_id to select the affected order.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.users.resetPassword(options: UsersResetPasswordOptions): Promise<UsersResetPasswordResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	UserPasswordResetRequestRequest	Required	—

Example

const result = await client.users.resetPassword({
  id: "550e8400-e29b-41d4-a716-446655440000",
  body: {}
});

Returns

User

The request was accepted and the updated resource is returned.

typeUser43fields

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

FieldTypeRequirementDescription

id

string

Required

—

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

string

Required

—

is_reseller

boolean

Optional

Reseller can create sub-users and manage their data.

is_marketer

boolean

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

boolean

Optional

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

date_joined

string

Required

—

date_joined_ts

number

Required

Timestamp of when the user joined

first_name

string

Optional

—

last_name

string

Optional

—

balance

number

Optional

—

language

LanguageEnum

Optional

—

enumLanguageEnum0fields

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

No fields.

country

string

Optional

—

state

string

Optional

—

city

string

Optional

—

address

string

Optional

—

zip

string

Optional

—

company_name

string

Optional

—

company_address

string

Optional

—

company_city

string

Optional

—

company_postal_code

string

Optional

—

company_country

string

Optional

—

company_vat_number

string

Optional

—

allowed_ips

string[]

Required

List of IP addresses allowed for this user

blocked_domains

string[]

Required

List of domains blocked for this user

connection_limit

number

Optional

The maximum number of concurrent connections allowed for this package.

parent_id

string

Required

ID of the parent user (for sub-accounts)

sub_users

number

Required

Number of sub-users managed by this reseller

referrals

number

Required

Number of users referred by this user

referral_id

string

Optional

—

referral_code

string

Required

—

referral_data_earned

number

Required

—

referral_data_pending

number

Required

—

referral_balance_pending

number

Required

—

referral_balance_earned

number

Required

—

currency

UserCurrency

Required

Currency information for the user's transactions

typeUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

—

symbol

string

Required

—

coupons

CouponShort[]

Required

Available coupons for this user

typeCouponShort14fields

FieldTypeRequirementDescription

id

string

Optional

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

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

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

number

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

Order[]

Optional

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.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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.

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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.

data

number

Optional

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

data_remaining

number

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.

data_spent

number

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

DataLedger[]

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.

typeDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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.

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.resetPasswordWithResponse(options): Promise<ApiResponse<UsersResetPasswordResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.users.reset_password(id: UUID, *, body: UserPasswordResetRequest, accept_language: str | Unset=UNSET) -> User

Asyncawait async_client.users.reset_password(id: UUID, *, body: UserPasswordResetRequest, accept_language: str | Unset=UNSET) -> User

Parameters

Name	Type	Requirement	Description
id	str	Required	A UUID string identifying this user.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	UserPasswordResetRequestRequest	Required	—

Example

result = client.users.reset_password(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.UserPasswordResetRequestRequest.from_dict({}),
    )

Async example

result = await async_client.users.reset_password(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.UserPasswordResetRequestRequest.from_dict({}),
    )

Returns

User

The request was accepted and the updated resource is returned.

classUser43fields

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

FieldTypeRequirementDescription

id

UUID

Required

—

username

str

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore.

email

str

Required

—

date_joined

datetime.datetime

Required

—

date_joined_ts

int

Required

Timestamp of when the user joined

allowed_ips

list[str]

Required

List of IP addresses allowed for this user

blocked_domains

list[str]

Required

List of domains blocked for this user

parent_id

str

Required

ID of the parent user (for sub-accounts)

sub_users

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referral_code

str

Required

—

referral_data_earned

int

Required

—

referral_data_pending

int

Required

—

referral_balance_pending

int

Required

—

referral_balance_earned

int

Required

—

currency

UserCurrency

Required

—

classUserCurrency2fields

FieldTypeRequirementDescription

code

str

Required

—

symbol

str

Required

—

coupons

list[CouponShort]

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

created

datetime.datetime

Required

—

value

int

Required

Arbitrary coupon value

code

str

Required

Leaving this field empty will generate a random code.

type_

CouponTypeEnum

Required

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

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

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

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

is_reseller

bool

Optional

Reseller can create sub-users and manage their data.

is_marketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

is_superuser

bool

Optional

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

first_name

str

Optional

—

last_name

str

Optional

—

balance

int

Optional

—

language

LanguageEnum

Optional

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

enumLanguageEnum0fields

No fields.

country

str

Optional

—

state

str

Optional

—

city

str

Optional

—

address

str

Optional

—

zip_

str

Optional

—

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_country

str

Optional

—

company_vat_number

str

Optional

—

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

referral_id

str

Optional

—

data

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_spent

int | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

data_updated

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password

None | str

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxy_password_reset

datetime.datetime | None

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

list[Order]

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

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.

ledgers

list[DataLedger]

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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.

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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.

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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.

data

int

Optional

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

data_spent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.users.reset_password_with_response(id: UUID, *, body: UserPasswordResetRequest, accept_language: str | Unset=UNSET) -> ApiResponse[User]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->users()->resetPassword($id, $userPasswordResetRequest, $acceptLanguage = null, string $contentType = self::contentTypes['resetPassword'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A UUID string identifying this user.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
userPasswordResetRequest	UserPasswordResetRequest	Required	—

Example

$result = $client->users()->resetPassword(
    id: '550e8400-e29b-41d4-a716-446655440000',
    userPasswordResetRequest: new Dto\UserPasswordResetRequest([
        'package_id' => '550e8400-e29b-41d4-a716-446655440000',
    ]),
);

Returns

User

The request was accepted and the updated resource is returned.

classUser43fields

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

FieldTypeRequirementDescription

id

string

Required

| [readonly]

username

string

Required

Value must contain only letters, numbers, and underscores. It must not start or end with an underscore. |

email

string

Required

|

isReseller

bool

Optional

Reseller can create sub-users and manage their data.

isMarketer

bool

Optional

Marketer can manage marketing campaigns and view analytics.

isSuperuser

bool

Optional

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

dateJoined

DateTime

Required

| [readonly]

dateJoinedTs

int

Required

Timestamp of when the user joined

firstName

string

Required

| [optional]

lastName

string

Required

| [optional]

balance

int

Required

| [optional]

language

LanguageEnum

Required

| [optional]

enumLanguageEnum0fields

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

No fields.

country

string

Required

| [optional]

state

string

Required

| [optional]

city

string

Required

| [optional]

address

string

Required

| [optional]

zip

string

Required

| [optional]

companyName

string

Required

| [optional]

companyAddress

string

Required

| [optional]

companyCity

string

Required

| [optional]

companyPostalCode

string

Required

| [optional]

companyCountry

string

Required

| [optional]

companyVatNumber

string

Required

| [optional]

allowedIps

array<string>

Required

List of IP addresses allowed for this user

blockedDomains

array<string>

Required

List of domains blocked for this user

connectionLimit

int

Optional

The maximum number of concurrent connections allowed for this package.

parentId

string

Required

ID of the parent user (for sub-accounts)

subUsers

int

Required

Number of sub-users managed by this reseller

referrals

int

Required

Number of users referred by this user

referralId

string

Required

| [optional]

referralCode

string

Required

| [readonly]

referralDataEarned

int

Required

| [readonly]

referralDataPending

int

Required

| [readonly]

referralBalancePending

int

Required

| [readonly]

referralBalanceEarned

int

Required

| [readonly]

currency

UserCurrency

Required

Currency information for the user's transactions

classUserCurrency2fields

FieldTypeRequirementDescription

code

string

Required

|

symbol

string

Required

|

coupons

[CouponShort[]](CouponShort.md)

Required

Available coupons for this user

classCouponShort14fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

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

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

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

user

string

Required

The user who created this coupon.

data

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataSpent

int

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

dataUpdated

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPassword

string

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

proxyPasswordReset

DateTime

Optional

Present only when SITE_PACKAGE_BASED_AUTH is disabled.

orders

[Order[]](Order.md)

Optional

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.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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.

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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.

data

int

Optional

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

dataRemaining

int

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.

dataSpent

int

Optional

Total bytes consumed from this order's data allowance so far. Updated in real time as the customer uses the proxy.

ledgers

[DataLedger[]](DataLedger.md)

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.

classDataLedger6fields

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.

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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.

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->users()->resetPasswordWithResponse($id, $userPasswordResetRequest, $acceptLanguage = null, string $contentType = self::contentTypes['resetPassword'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->users()->resetPasswordWithHttpInfo($id, $userPasswordResetRequest, $acceptLanguage = null, string $contentType = self::contentTypes['resetPassword'][0])

  Returns the OpenAPI Generator response tuple.

• $client->users()->resetPasswordAsync($id, $userPasswordResetRequest, $acceptLanguage = null, string $contentType = self::contentTypes['resetPassword'][0])

  Returns a Guzzle promise for the decoded result.

• $client->users()->resetPasswordAsyncWithHttpInfo($id, $userPasswordResetRequest, $acceptLanguage = null, string $contentType = self::contentTypes['resetPassword'][0])

  Returns a Guzzle promise for the response tuple.

• $client->users()->resetPasswordRequest($id, $userPasswordResetRequest, $acceptLanguage = null, string $contentType = self::contentTypes['resetPassword'][0])

  Builds the PSR-7 request without sending it.