Profile

SDK Reference · Resource

Profile

Read and update the authenticated account and its security settings.

get()update()delete()confirmTwoFactor()disableTwoFactor()setupTwoFactor()getTwoFactorStatus()changePassword()

method

get()

Get the current profile

Returns the authenticated account, including contact details and the security state needed by account settings screens.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.profile.get(options: ProfileGetOptions = {}): Promise<ProfileGetResponse>

Parameters

Name	Type	Requirement	Description
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.profile.get();

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: "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.profile.getWithResponse(options): Promise<ApiResponse<ProfileGetResponse>>

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

Signature

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

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

Parameters

Name	Type	Requirement	Description
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.profile.get()

Async example

result = await async_client.profile.get()

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.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.profile.get_with_response(*, accept_language: str | Unset=UNSET) -> ApiResponse[User]

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

Signature

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

Parameters

Name	Type	Requirement	Description
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->profile()->get();

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::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->profile()->getWithResponse($acceptLanguage = null, string $contentType = self::contentTypes['get'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

update()

Update the current profile

Updates the supplied profile fields and returns the latest account state. Fields omitted from the request are left unchanged.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.profile.update(options: ProfileUpdateOptions = {}): Promise<ProfileUpdateResponse>

Parameters

Name	Type	Requirement	Description
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	PatchedProfileUpdateRequest	Optional	—

Example

const result = await client.profile.update({
  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: "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.profile.updateWithResponse(options): Promise<ApiResponse<ProfileUpdateResponse>>

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

Signature

Syncclient.profile.update(*, body: PatchedProfileUpdateRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> User

Asyncawait async_client.profile.update(*, body: PatchedProfileUpdateRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> User

Parameters

Name	Type	Requirement	Description
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	PatchedProfileUpdateRequest	Optional	—

Example

result = client.profile.update(
        body=models.PatchedProfileUpdateRequest.from_dict({}),
    )

Async example

result = await async_client.profile.update(
        body=models.PatchedProfileUpdateRequest.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.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.profile.update_with_response(*, body: PatchedProfileUpdateRequest | 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->profile()->update($ifMatch = null, $acceptLanguage = null, $patchedProfileUpdateRequest = null, string $contentType = self::contentTypes['update'][0])

Parameters

Name	Type	Requirement	Description
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.
patchedProfileUpdateRequest	PatchedProfileUpdateRequest	Optional	—

Example

$result = $client->profile()->update(
    patchedProfileUpdateRequest: new Dto\PatchedProfileUpdateRequest([]),
);

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::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->profile()->updateWithResponse($ifMatch = null, $acceptLanguage = null, $patchedProfileUpdateRequest = null, string $contentType = self::contentTypes['update'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

delete()

Delete the current account

Permanently deletes the authenticated customer account. Superusers and reseller sub-accounts cannot delete themselves with this operation.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.profile.delete(options: ProfileDeleteOptions = {}): Promise<ProfileDeleteResponse>

Parameters

Name	Type	Requirement	Description
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.profile.delete();

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: "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.profile.deleteWithResponse(options): Promise<ApiResponse<ProfileDeleteResponse>>

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

Signature

Syncclient.profile.delete(*, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> None

Asyncawait async_client.profile.delete(*, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> None

Parameters

Name	Type	Requirement	Description
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.profile.delete()

Async example

result = await async_client.profile.delete()

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.VALIDATIONThe request arguments or business rules are invalid.
• 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.profile.delete_with_response(*, 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->profile()->delete($ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

Parameters

Name	Type	Requirement	Description
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->profile()->delete();

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::ValidationThe request arguments or business rules are invalid.
• 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->profile()->deleteWithResponse($ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

confirmTwoFactor()

Confirm two-factor authentication

Activates the pending authenticator after verifying its code and revokes previous JWTs.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.profile.confirmTwoFactor(options: ProfileConfirmTwoFactorOptions): Promise<ProfileConfirmTwoFactorResponse>

Parameters

Name	Type	Requirement	Description
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	TwoFactorConfirmRequest	Required	—

Example

const result = await client.profile.confirmTwoFactor({
  body: {
    "code": "{code}"
  }
});

Returns

EnabledResponse

The operation completed successfully.

typeEnabledResponse1field

FieldTypeRequirementDescription

enabled

boolean

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.profile.confirmTwoFactorWithResponse(options): Promise<ApiResponse<ProfileConfirmTwoFactorResponse>>

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

Signature

Syncclient.profile.confirm_two_factor(*, body: TwoFactorConfirmRequest, accept_language: str | Unset=UNSET) -> EnabledResponse

Asyncawait async_client.profile.confirm_two_factor(*, body: TwoFactorConfirmRequest, accept_language: str | Unset=UNSET) -> EnabledResponse

Parameters

Name	Type	Requirement	Description
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	TwoFactorConfirmRequest	Required	—

Example

result = client.profile.confirm_two_factor(
        body=models.TwoFactorConfirmRequest.from_dict({'code': '{code}'}),
    )

Async example

result = await async_client.profile.confirm_two_factor(
        body=models.TwoFactorConfirmRequest.from_dict({'code': '{code}'}),
    )

Returns

EnabledResponse

The operation completed successfully.

classEnabledResponse1field

FieldTypeRequirementDescription

enabled

bool

Required

—

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.profile.confirm_two_factor_with_response(*, body: TwoFactorConfirmRequest, accept_language: str | Unset=UNSET) -> ApiResponse[EnabledResponse]

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

Signature

Sync$client->profile()->confirmTwoFactor($twoFactorConfirmRequest, $acceptLanguage = null, string $contentType = self::contentTypes['confirmTwoFactor'][0])

Parameters

Name	Type	Requirement	Description
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.
twoFactorConfirmRequest	TwoFactorConfirmRequest	Required	—

Example

$result = $client->profile()->confirmTwoFactor(
    twoFactorConfirmRequest: new Dto\TwoFactorConfirmRequest([
        'code' => '{code}',
    ]),
);

Returns

EnabledResponse

The operation completed successfully.

classEnabledResponse1field

FieldTypeRequirementDescription

enabled

bool

Required

|

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->profile()->confirmTwoFactorWithResponse($twoFactorConfirmRequest, $acceptLanguage = null, string $contentType = self::contentTypes['confirmTwoFactor'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->profile()->confirmTwoFactorWithHttpInfo($twoFactorConfirmRequest, $acceptLanguage = null, string $contentType = self::contentTypes['confirmTwoFactor'][0])

  Returns the OpenAPI Generator response tuple.

• $client->profile()->confirmTwoFactorAsync($twoFactorConfirmRequest, $acceptLanguage = null, string $contentType = self::contentTypes['confirmTwoFactor'][0])

  Returns a Guzzle promise for the decoded result.

• $client->profile()->confirmTwoFactorAsyncWithHttpInfo($twoFactorConfirmRequest, $acceptLanguage = null, string $contentType = self::contentTypes['confirmTwoFactor'][0])

  Returns a Guzzle promise for the response tuple.

• $client->profile()->confirmTwoFactorRequest($twoFactorConfirmRequest, $acceptLanguage = null, string $contentType = self::contentTypes['confirmTwoFactor'][0])

  Builds the PSR-7 request without sending it.

method

disableTwoFactor()

Disable two-factor authentication

Requires the primary factor and current authenticator code, then revokes previous JWTs.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.profile.disableTwoFactor(options: ProfileDisableTwoFactorOptions): Promise<ProfileDisableTwoFactorResponse>

Parameters

Name	Type	Requirement	Description
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	TwoFactorDisableRequest	Required	—

Example

const result = await client.profile.disableTwoFactor({
  body: {
    "code": "{code}"
  }
});

Returns

EnabledResponse

The operation completed successfully.

typeEnabledResponse1field

FieldTypeRequirementDescription

enabled

boolean

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.profile.disableTwoFactorWithResponse(options): Promise<ApiResponse<ProfileDisableTwoFactorResponse>>

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

Signature

Syncclient.profile.disable_two_factor(*, body: TwoFactorDisableRequest, accept_language: str | Unset=UNSET) -> EnabledResponse

Asyncawait async_client.profile.disable_two_factor(*, body: TwoFactorDisableRequest, accept_language: str | Unset=UNSET) -> EnabledResponse

Parameters

Name	Type	Requirement	Description
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	TwoFactorDisableRequest	Required	—

Example

result = client.profile.disable_two_factor(
        body=models.TwoFactorDisableRequest.from_dict({'code': '{code}'}),
    )

Async example

result = await async_client.profile.disable_two_factor(
        body=models.TwoFactorDisableRequest.from_dict({'code': '{code}'}),
    )

Returns

EnabledResponse

The operation completed successfully.

classEnabledResponse1field

FieldTypeRequirementDescription

enabled

bool

Required

—

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.profile.disable_two_factor_with_response(*, body: TwoFactorDisableRequest, accept_language: str | Unset=UNSET) -> ApiResponse[EnabledResponse]

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

Signature

Sync$client->profile()->disableTwoFactor($twoFactorDisableRequest, $acceptLanguage = null, string $contentType = self::contentTypes['disableTwoFactor'][0])

Parameters

Name	Type	Requirement	Description
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.
twoFactorDisableRequest	TwoFactorDisableRequest	Required	—

Example

$result = $client->profile()->disableTwoFactor(
    twoFactorDisableRequest: new Dto\TwoFactorDisableRequest([
        'code' => '{code}',
    ]),
);

Returns

EnabledResponse

The operation completed successfully.

classEnabledResponse1field

FieldTypeRequirementDescription

enabled

bool

Required

|

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->profile()->disableTwoFactorWithResponse($twoFactorDisableRequest, $acceptLanguage = null, string $contentType = self::contentTypes['disableTwoFactor'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->profile()->disableTwoFactorWithHttpInfo($twoFactorDisableRequest, $acceptLanguage = null, string $contentType = self::contentTypes['disableTwoFactor'][0])

  Returns the OpenAPI Generator response tuple.

• $client->profile()->disableTwoFactorAsync($twoFactorDisableRequest, $acceptLanguage = null, string $contentType = self::contentTypes['disableTwoFactor'][0])

  Returns a Guzzle promise for the decoded result.

• $client->profile()->disableTwoFactorAsyncWithHttpInfo($twoFactorDisableRequest, $acceptLanguage = null, string $contentType = self::contentTypes['disableTwoFactor'][0])

  Returns a Guzzle promise for the response tuple.

• $client->profile()->disableTwoFactorRequest($twoFactorDisableRequest, $acceptLanguage = null, string $contentType = self::contentTypes['disableTwoFactor'][0])

  Builds the PSR-7 request without sending it.

method

setupTwoFactor()

Prepare two-factor authentication

Confirms the primary factor and prepares a pending secret without disabling current protection.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.profile.setupTwoFactor(options: ProfileSetupTwoFactorOptions = {}): Promise<ProfileSetupTwoFactorResponse>

Parameters

Name	Type	Requirement	Description
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	TwoFactorSetupRequestRequest	Optional	—

Example

const result = await client.profile.setupTwoFactor({
  body: {}
});

Returns

TwoFactorSetupResponse

The operation completed successfully.

typeTwoFactorSetupResponse3fields

FieldTypeRequirementDescription

secret

string

Required

—

otpauth_url

string

Required

—

qr_png_base64

string

Optional

—

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.profile.setupTwoFactorWithResponse(options): Promise<ApiResponse<ProfileSetupTwoFactorResponse>>

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

Signature

Syncclient.profile.setup_two_factor(*, body: TwoFactorSetupRequestRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> TwoFactorSetupResponse

Asyncawait async_client.profile.setup_two_factor(*, body: TwoFactorSetupRequestRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> TwoFactorSetupResponse

Parameters

Name	Type	Requirement	Description
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	TwoFactorSetupRequestRequest	Optional	—

Example

result = client.profile.setup_two_factor(
        body=models.TwoFactorSetupRequestRequest.from_dict({}),
    )

Async example

result = await async_client.profile.setup_two_factor(
        body=models.TwoFactorSetupRequestRequest.from_dict({}),
    )

Returns

TwoFactorSetupResponse

The operation completed successfully.

classTwoFactorSetupResponse3fields

FieldTypeRequirementDescription

secret

str

Required

—

otpauth_url

str

Required

—

qr_png_base64

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.profile.setup_two_factor_with_response(*, body: TwoFactorSetupRequestRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[TwoFactorSetupResponse]

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

Signature

Sync$client->profile()->setupTwoFactor($acceptLanguage = null, $twoFactorSetupRequestRequest = null, string $contentType = self::contentTypes['setupTwoFactor'][0])

Parameters

Name	Type	Requirement	Description
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.
twoFactorSetupRequestRequest	TwoFactorSetupRequestRequest	Optional	—

Example

$result = $client->profile()->setupTwoFactor(
    twoFactorSetupRequestRequest: new Dto\TwoFactorSetupRequestRequest([]),
);

Returns

TwoFactorSetupResponse

The operation completed successfully.

classTwoFactorSetupResponse3fields

FieldTypeRequirementDescription

secret

string

Required

|

otpauthUrl

string

Required

|

qrPngBase64

string

Required

| [optional]

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->profile()->setupTwoFactorWithResponse($acceptLanguage = null, $twoFactorSetupRequestRequest = null, string $contentType = self::contentTypes['setupTwoFactor'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->profile()->setupTwoFactorWithHttpInfo($acceptLanguage = null, $twoFactorSetupRequestRequest = null, string $contentType = self::contentTypes['setupTwoFactor'][0])

  Returns the OpenAPI Generator response tuple.

• $client->profile()->setupTwoFactorAsync($acceptLanguage = null, $twoFactorSetupRequestRequest = null, string $contentType = self::contentTypes['setupTwoFactor'][0])

  Returns a Guzzle promise for the decoded result.

• $client->profile()->setupTwoFactorAsyncWithHttpInfo($acceptLanguage = null, $twoFactorSetupRequestRequest = null, string $contentType = self::contentTypes['setupTwoFactor'][0])

  Returns a Guzzle promise for the response tuple.

• $client->profile()->setupTwoFactorRequest($acceptLanguage = null, $twoFactorSetupRequestRequest = null, string $contentType = self::contentTypes['setupTwoFactor'][0])

  Builds the PSR-7 request without sending it.

method

getTwoFactorStatus()

Get two-factor status

Returns whether TOTP two-factor authentication is enabled for the authenticated account.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.profile.getTwoFactorStatus(options: ProfileGetTwoFactorStatusOptions = {}): Promise<ProfileGetTwoFactorStatusResponse>

Parameters

Name	Type	Requirement	Description
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.profile.getTwoFactorStatus();

Returns

EnabledResponse

The operation completed successfully.

typeEnabledResponse1field

FieldTypeRequirementDescription

enabled

boolean

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.profile.getTwoFactorStatusWithResponse(options): Promise<ApiResponse<ProfileGetTwoFactorStatusResponse>>

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

Signature

Syncclient.profile.get_two_factor_status(*, accept_language: str | Unset=UNSET) -> EnabledResponse

Asyncawait async_client.profile.get_two_factor_status(*, accept_language: str | Unset=UNSET) -> EnabledResponse

Parameters

Name	Type	Requirement	Description
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.profile.get_two_factor_status()

Async example

result = await async_client.profile.get_two_factor_status()

Returns

EnabledResponse

The operation completed successfully.

classEnabledResponse1field

FieldTypeRequirementDescription

enabled

bool

Required

—

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.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.profile.get_two_factor_status_with_response(*, accept_language: str | Unset=UNSET) -> ApiResponse[EnabledResponse]

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

Signature

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

Parameters

Name	Type	Requirement	Description
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->profile()->getTwoFactorStatus();

Returns

EnabledResponse

The operation completed successfully.

classEnabledResponse1field

FieldTypeRequirementDescription

enabled

bool

Required

|

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::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->profile()->getTwoFactorStatusWithResponse($acceptLanguage = null, string $contentType = self::contentTypes['getTwoFactorStatus'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->profile()->getTwoFactorStatusWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['getTwoFactorStatus'][0])

  Returns the OpenAPI Generator response tuple.

• $client->profile()->getTwoFactorStatusAsync($acceptLanguage = null, string $contentType = self::contentTypes['getTwoFactorStatus'][0])

  Returns a Guzzle promise for the decoded result.

• $client->profile()->getTwoFactorStatusAsyncWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['getTwoFactorStatus'][0])

  Returns a Guzzle promise for the response tuple.

• $client->profile()->getTwoFactorStatusRequest($acceptLanguage = null, string $contentType = self::contentTypes['getTwoFactorStatus'][0])

  Builds the PSR-7 request without sending it.

method

changePassword()

Change the account password

Verifies the current password, applies the new password, and keeps the current authenticated session active.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.profile.changePassword(options: ProfileChangePasswordOptions): Promise<ProfileChangePasswordResponse>

Parameters

Name	Type	Requirement	Description
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	ChangePasswordRequest	Required	—

Example

const result = await client.profile.changePassword({
  body: {
    "old_password": "Correct-Horse-Battery-Staple-42",
    "new_password1": "Correct-Horse-Battery-Staple-42",
    "new_password2": "Correct-Horse-Battery-Staple-42"
  }
});

Returns

MessageResponse

The operation completed successfully.

typeMessageResponse1field

FieldTypeRequirementDescription

detail

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.profile.changePasswordWithResponse(options): Promise<ApiResponse<ProfileChangePasswordResponse>>

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

Signature

Syncclient.profile.change_password(*, body: ChangePasswordRequest, accept_language: str | Unset=UNSET) -> MessageResponse

Asyncawait async_client.profile.change_password(*, body: ChangePasswordRequest, accept_language: str | Unset=UNSET) -> MessageResponse

Parameters

Name	Type	Requirement	Description
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	ChangePasswordRequest	Required	—

Example

result = client.profile.change_password(
        body=models.ChangePasswordRequest.from_dict({'old_password': 'Correct-Horse-Battery-Staple-42', 'new_password1': 'Correct-Horse-Battery-Staple-42', 'new_password2': 'Correct-Horse-Battery-Staple-42'}),
    )

Async example

result = await async_client.profile.change_password(
        body=models.ChangePasswordRequest.from_dict({'old_password': 'Correct-Horse-Battery-Staple-42', 'new_password1': 'Correct-Horse-Battery-Staple-42', 'new_password2': 'Correct-Horse-Battery-Staple-42'}),
    )

Returns

MessageResponse

The operation completed successfully.

classMessageResponse1field

FieldTypeRequirementDescription

detail

str

Required

—

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.profile.change_password_with_response(*, body: ChangePasswordRequest, accept_language: str | Unset=UNSET) -> ApiResponse[MessageResponse]

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

Signature

Sync$client->profile()->changePassword($changePasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['changePassword'][0])

Parameters

Name	Type	Requirement	Description
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.
changePasswordRequest	ChangePasswordRequest	Required	—

Example

$result = $client->profile()->changePassword(
    changePasswordRequest: new Dto\ChangePasswordRequest([
        'old_password' => 'Correct-Horse-Battery-Staple-42',
        'new_password1' => 'Correct-Horse-Battery-Staple-42',
        'new_password2' => 'Correct-Horse-Battery-Staple-42',
    ]),
);

Returns

MessageResponse

The operation completed successfully.

classMessageResponse1field

FieldTypeRequirementDescription

detail

string

Required

|

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->profile()->changePasswordWithResponse($changePasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['changePassword'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->profile()->changePasswordWithHttpInfo($changePasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['changePassword'][0])

  Returns the OpenAPI Generator response tuple.

• $client->profile()->changePasswordAsync($changePasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['changePassword'][0])

  Returns a Guzzle promise for the decoded result.

• $client->profile()->changePasswordAsyncWithHttpInfo($changePasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['changePassword'][0])

  Returns a Guzzle promise for the response tuple.

• $client->profile()->changePasswordRequest($changePasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['changePassword'][0])

  Builds the PSR-7 request without sending it.