Orders

SDK Reference · Resource

Orders

Review purchased packages, allocated data, and proxy credentials.

list()get()updateAutoRenewal()delete()resetPassword()

method

list()

List active orders

Returns active package orders owned by the authenticated account. Superusers can inspect other accounts, including inactive orders; filters never expand a normal caller's ownership scope. Repeated purchases of one package reuse the same user/package order. Read data_remaining and ledgers for usable purchased data, not data minus data_spent. To inspect a managed customer, use /users/{id}/orders.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.orders.list(options: OrdersListOptions = {}): Promise<OrdersListResponse>

Parameters

Name	Type	Requirement	Description
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageAlias	string	Optional	—
packageId	string	Optional	—
packageType	string	Optional	* `static` - Static * `residential` - Residential
search	string	Optional	Case-insensitive partial search across Order fields: `id`, `alias`, `internal_id`, and `proxy_password`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
userEmail	string	Optional	—
userId	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

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

Returns

PaginatedOrderList

The operation completed successfully.

typePaginatedOrderList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

Order[]

Required

—

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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

data

number

Optional

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

data_remaining

number

Required

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

data_spent

number

Optional

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

ledgers

DataLedger[]

Required

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

typeDataLedger6fields

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

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "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.orders.listWithResponse(options): Promise<ApiResponse<OrdersListResponse>>

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

Signature

Syncclient.orders.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_alias: str | Unset=UNSET, package_id: str | Unset=UNSET, package_type: OrdersListPackageType | Unset=UNSET, search: str | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedOrderList

Asyncawait async_client.orders.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_alias: str | Unset=UNSET, package_id: str | Unset=UNSET, package_type: OrdersListPackageType | Unset=UNSET, search: str | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedOrderList

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
package_alias	str	Optional	—
package_id	str	Optional	—
package_type	str	Optional	* `static` - Static * `residential` - Residential
search	str	Optional	Case-insensitive partial search across Order fields: `id`, `alias`, `internal_id`, and `proxy_password`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
user_email	str	Optional	—
user_id	str	Optional	—
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.orders.list()

Async example

result = await async_client.orders.list()

Returns

PaginatedOrderList

The operation completed successfully.

classPaginatedOrderList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[Order]

Required

—

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

Required

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

ledgers

list[DataLedger]

Required

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

classDataLedger6fields

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

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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

data

int

Optional

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

data_spent

int

Optional

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

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.orders.list_with_response(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_alias: str | Unset=UNSET, package_id: str | Unset=UNSET, package_type: OrdersListPackageType | Unset=UNSET, search: str | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedOrderList]

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

Signature

Sync$client->orders()->list($limit = null, $offset = null, $ordering = null, $packageAlias = null, $packageId = null, $packageType = null, $search = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
packageAlias	string	Optional	—
packageId	string	Optional	—
packageType	string	Optional	* `static` - Static * `residential` - Residential
search	string	Optional	Case-insensitive partial search across Order fields: `id`, `alias`, `internal_id`, and `proxy_password`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
userEmail	string	Optional	—
userId	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

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

Returns

PaginatedOrderList

The operation completed successfully.

classPaginatedOrderList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[Order[]](Order.md)

Required

|

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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

data

int

Optional

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

dataRemaining

int

Required

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

dataSpent

int

Optional

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

ledgers

[DataLedger[]](DataLedger.md)

Required

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

classDataLedger6fields

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

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::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->orders()->listWithResponse($limit = null, $offset = null, $ordering = null, $packageAlias = null, $packageId = null, $packageType = null, $search = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->orders()->listWithHttpInfo($limit = null, $offset = null, $ordering = null, $packageAlias = null, $packageId = null, $packageType = null, $search = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns the OpenAPI Generator response tuple.

• $client->orders()->listAsync($limit = null, $offset = null, $ordering = null, $packageAlias = null, $packageId = null, $packageType = null, $search = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the decoded result.

• $client->orders()->listAsyncWithHttpInfo($limit = null, $offset = null, $ordering = null, $packageAlias = null, $packageId = null, $packageType = null, $search = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the response tuple.

• $client->orders()->listRequest($limit = null, $offset = null, $ordering = null, $packageAlias = null, $packageId = null, $packageType = null, $search = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Builds the PSR-7 request without sending it.

method

get()

Get an order

Returns one active order with package, usage, expiration, and proxy credential details. Virtual child data_remaining is a personal quota, not the parent's shared balance. The order's expires value is not a list of all purchased bucket deadlines; inspect each returned ledger's expires.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.orders.get(options: OrdersGetOptions): Promise<OrdersGetResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Order.
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.orders.get({
  id: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

OrderDetailed

The operation completed successfully.

typeOrderDetailed18fields

FieldTypeRequirementDescription

id

string

Optional

—

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

—

is_active

boolean

Optional

When enabled, the customer can actively use proxies on this order. Disable to suspend access without deleting the order.

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.

user_id

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. Virtual child order: max(data - data_spent, 0); access also needs a usable parent pool.

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 purchased buckets; empty for virtual child orders. Not a complete history, and array position is not spending priority.

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

—

expires

string

Optional

Date and time when this order expires and access is revoked. Leave blank for orders that do not expire.

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.orders.getWithResponse(options): Promise<ApiResponse<OrdersGetResponse>>

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

Signature

Syncclient.orders.get(id: str, *, accept_language: str | Unset=UNSET) -> OrderDetailed

Asyncawait async_client.orders.get(id: str, *, accept_language: str | Unset=UNSET) -> OrderDetailed

Parameters

Name	Type	Requirement	Description
id	str	Required	A unique value identifying this Order.
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.orders.get(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

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

Returns

OrderDetailed

The operation completed successfully.

classOrderDetailed18fields

FieldTypeRequirementDescription

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.

is_auto_renewal

bool

Required

—

user_id

UUID

Required

—

data_remaining

int

Required

Integer bytes. Root order: sum of usable ledger balances. Virtual child order: max(data - data_spent, 0); access also needs a usable parent pool.

ledgers

list[DataLedger]

Required

Usable, non-expired purchased buckets; empty for virtual child orders. Not a complete history, and array position is not spending priority.

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

—

id

str

Optional

—

is_active

bool

Optional

When enabled, the customer can actively use proxies on this order. Disable to suspend access without deleting the order.

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.

expires

datetime.datetime | None

Optional

Date and time when this order expires and access is revoked. Leave blank for orders that do not expire.

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

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

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

Signature

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

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Order.
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->orders()->get(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

OrderDetailed

The operation completed successfully.

classOrderDetailed18fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

package

PackageShort

Required

|

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

|

isActive

bool

Optional

When enabled, the customer can actively use proxies on this order. Disable to suspend access without deleting the order.

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.

userId

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. Virtual child order: max(data - data_spent, 0); access also needs a usable parent pool.

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 purchased buckets; empty for virtual child orders. Not a complete history, and array position is not spending priority.

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]

expires

DateTime

Optional

Date and time when this order expires and access is revoked. Leave blank for orders that do not expire.

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

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

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

updateAutoRenewal()

Update order auto-renewal

Updates only the auto-renewal threshold and top-up amount for an active order owned by the authenticated account. Set both values to zero to disable it.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.orders.updateAutoRenewal(options: OrdersUpdateAutoRenewalOptions): Promise<OrdersUpdateAutoRenewalResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Order.
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	PatchedOrderAutoRenewalRequest	Optional	—

Example

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

Returns

Order

The operation completed successfully.

typeOrder17fields

FieldTypeRequirementDescription

id

string

Optional

—

is_auto_renewal

boolean

Required

—

auto_renewal_percentage

number

Optional

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

auto_renewal_data

number

Optional

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

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

proxy_password

string

Optional

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

proxy_password_reset

string

Optional

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

pools

string[]

Optional

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

data

number

Optional

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

data_remaining

number

Required

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

data_spent

number

Optional

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

ledgers

DataLedger[]

Required

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

typeDataLedger6fields

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

FieldTypeRequirementDescription

id

string

Required

—

data

number

Required

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

data_remaining

number

Required

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

expires

string

Required

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

updated

string

Required

—

created

string

Required

—

latest_data_top_up

number

Optional

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

latest_data_top_up_date

string

Optional

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

data_updated

string

Required

—

updated

string

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.orders.updateAutoRenewalWithResponse(options): Promise<ApiResponse<OrdersUpdateAutoRenewalResponse>>

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

Signature

Syncclient.orders.update_auto_renewal(id: str, *, body: PatchedOrderAutoRenewalRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Order

Asyncawait async_client.orders.update_auto_renewal(id: str, *, body: PatchedOrderAutoRenewalRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Order

Parameters

Name	Type	Requirement	Description
id	str	Required	A unique value identifying this Order.
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	PatchedOrderAutoRenewalRequest	Optional	—

Example

result = client.orders.update_auto_renewal(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.PatchedOrderAutoRenewalRequest.from_dict({}),
    )

Async example

result = await async_client.orders.update_auto_renewal(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.PatchedOrderAutoRenewalRequest.from_dict({}),
    )

Returns

Order

The operation completed successfully.

classOrder17fields

FieldTypeRequirementDescription

is_auto_renewal

bool

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

data_remaining

int

Required

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

ledgers

list[DataLedger]

Required

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

classDataLedger6fields

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

FieldTypeRequirementDescription

id

str

Required

—

data

int

Required

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

data_remaining

int

Required

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

expires

datetime.datetime | None

Required

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

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

data_updated

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

auto_renewal_percentage

int

Optional

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

auto_renewal_data

int

Optional

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

proxy_password

str

Optional

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

proxy_password_reset

datetime.datetime | None

Optional

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

pools

list[str]

Optional

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

data

int

Optional

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

data_spent

int

Optional

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

latest_data_top_up

int

Optional

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

latest_data_top_up_date

datetime.datetime | None

Optional

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

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.orders.update_auto_renewal_with_response(id: str, *, body: PatchedOrderAutoRenewalRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[Order]

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

Signature

Sync$client->orders()->updateAutoRenewal($id, $ifMatch = null, $acceptLanguage = null, $patchedOrderAutoRenewalRequest = null, string $contentType = self::contentTypes['updateAutoRenewal'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Order.
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.
patchedOrderAutoRenewalRequest	PatchedOrderAutoRenewalRequest	Optional	—

Example

$result = $client->orders()->updateAutoRenewal(
    id: '550e8400-e29b-41d4-a716-446655440000',
    patchedOrderAutoRenewalRequest: new Dto\PatchedOrderAutoRenewalRequest([]),
);

Returns

Order

The operation completed successfully.

classOrder17fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isAutoRenewal

bool

Required

| [readonly]

autoRenewalPercentage

int

Optional

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

autoRenewalData

int

Optional

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

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

proxyPassword

string

Optional

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

proxyPasswordReset

DateTime

Optional

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

pools

array<string>

Optional

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

data

int

Optional

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

dataRemaining

int

Required

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

dataSpent

int

Optional

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

ledgers

[DataLedger[]](DataLedger.md)

Required

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

classDataLedger6fields

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

FieldTypeRequirementDescription

id

string

Required

| [readonly]

data

int

Required

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

dataRemaining

int

Required

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

expires

DateTime

Required

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

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

latestDataTopUp

int

Optional

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

latestDataTopUpDate

DateTime

Optional

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

dataUpdated

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->orders()->updateAutoRenewalWithResponse($id, $ifMatch = null, $acceptLanguage = null, $patchedOrderAutoRenewalRequest = null, string $contentType = self::contentTypes['updateAutoRenewal'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->orders()->updateAutoRenewalWithHttpInfo($id, $ifMatch = null, $acceptLanguage = null, $patchedOrderAutoRenewalRequest = null, string $contentType = self::contentTypes['updateAutoRenewal'][0])

  Returns the OpenAPI Generator response tuple.

• $client->orders()->updateAutoRenewalAsync($id, $ifMatch = null, $acceptLanguage = null, $patchedOrderAutoRenewalRequest = null, string $contentType = self::contentTypes['updateAutoRenewal'][0])

  Returns a Guzzle promise for the decoded result.

• $client->orders()->updateAutoRenewalAsyncWithHttpInfo($id, $ifMatch = null, $acceptLanguage = null, $patchedOrderAutoRenewalRequest = null, string $contentType = self::contentTypes['updateAutoRenewal'][0])

  Returns a Guzzle promise for the response tuple.

• $client->orders()->updateAutoRenewalRequest($id, $ifMatch = null, $acceptLanguage = null, $patchedOrderAutoRenewalRequest = null, string $contentType = self::contentTypes['updateAutoRenewal'][0])

  Builds the PSR-7 request without sending it.

method

delete()

Delete a sub-user order

Removes an order in the caller's permitted scope. This is destructive, not a payment refund. Deleting a virtual child order does not credit its quota to the shared ledger. Independently purchased sub-user orders have a legacy parent-order data-counter adjustment; do not treat it as a guaranteed restoration of usable ledger balance.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.orders.delete(options: OrdersDeleteOptions): Promise<OrdersDeleteResponse>

Parameters

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

Example

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

Returns

void

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.orders.deleteWithResponse(options): Promise<ApiResponse<OrdersDeleteResponse>>

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

Signature

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

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

Parameters

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

Example

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

Async example

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

Returns

None

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

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

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

Signature

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

Parameters

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

Example

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

Returns

void

No response body

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

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

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

resetPassword()

Reset an order's proxy password

Rotates the proxy password for the order identified by order_id. Existing proxy connection strings stop working after the rotation; use the updated proxy password for all new connections.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.orders.resetPassword(options: OrdersResetPasswordOptions): Promise<OrdersResetPasswordResponse>

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	ResetPasswordRequest	Required	—

Example

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

Returns

ProxyPasswordResetResponse

The operation completed successfully.

typeProxyPasswordResetResponse2fields

FieldTypeRequirementDescription

message

string

Required

—

success

boolean

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "not_found"The requested resource does not exist.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.orders.resetPasswordWithResponse(options): Promise<ApiResponse<OrdersResetPasswordResponse>>

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

Signature

Syncclient.orders.reset_password(*, body: ResetPasswordRequest, accept_language: str | Unset=UNSET) -> ProxyPasswordResetResponse

Asyncawait async_client.orders.reset_password(*, body: ResetPasswordRequest, accept_language: str | Unset=UNSET) -> ProxyPasswordResetResponse

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	ResetPasswordRequest	Required	—

Example

result = client.orders.reset_password(
        body=models.ResetPasswordRequest.from_dict({'order_id': '550e8400-e29b-41d4-a716-446655440000'}),
    )

Async example

result = await async_client.orders.reset_password(
        body=models.ResetPasswordRequest.from_dict({'order_id': '550e8400-e29b-41d4-a716-446655440000'}),
    )

Returns

ProxyPasswordResetResponse

The operation completed successfully.

classProxyPasswordResetResponse2fields

FieldTypeRequirementDescription

message

str

Required

—

success

bool

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.orders.reset_password_with_response(*, body: ResetPasswordRequest, accept_language: str | Unset=UNSET) -> ApiResponse[ProxyPasswordResetResponse]

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

Signature

Sync$client->orders()->resetPassword($resetPasswordRequest, $acceptLanguage = null, string $contentType = self::contentTypes['resetPassword'][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.
resetPasswordRequest	ResetPasswordRequest	Required	—

Example

$result = $client->orders()->resetPassword(
    resetPasswordRequest: new Dto\ResetPasswordRequest([
        'order_id' => '550e8400-e29b-41d4-a716-446655440000',
    ]),
);

Returns

ProxyPasswordResetResponse

The operation completed successfully.

classProxyPasswordResetResponse2fields

FieldTypeRequirementDescription

message

string

Required

|

success

bool

Required

|

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

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

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.