Models

SDK Reference

Models

Public DTOs, enums and generated types exposed by each SDK.

JavaScript / TypeScriptPythonPHP

Filter 140 models

A

typeAddDataRequest2 fields

Field	Type	Requirement	Description
package_id	string	Required	Package for which the caller owns a root order.
data	number	Required	Positive integer bytes to add to the child's assigned quota. Does not reserve parent data; may exceed the parent's remaining pool.

typeAffiliate5 fields

Field	Type	Requirement	Description
id	string	Optional	—
email	string	Required	—
signup_ip	string	Optional	IP address from which the user signed up. This field is optional and can be used for tracking purposes.
signup_country	string	Optional	Country from which the user signed up. This field is optional and can be used for tracking purposes.
date_joined	string	Optional	—

typeAffiliateReward8 fields

Field	Type	Requirement	Description
id	string	Optional	—
email	string	Required	—
status	RewardStatusEnum	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled
package	PackageShort	Required	—
price_total	number	Required	—
data	number	Optional	The amount of data in bytes.
commission_amount	number	Required	—
created	string	Required	—

typeAffiliateStatsPoint4 fields

Field	Type	Requirement	Description
date	string	Optional	—
balance	number	Optional	—
data	number	Optional	—
count	number	Optional	—

typeAffiliateStatsResponse1 fields

Field	Type	Requirement	Description
results	AffiliateStatsPoint[]	Required	—

typeAPIKeyCreate5 fields

Field	Type	Requirement	Description
id	string	Optional	—
title	string	Required	—
key	string	Required	—
allowed_ips	string[]	Optional	—
created	string	Required	—

typeAPIKeyCreateRequest2 fields

Field	Type	Requirement	Description
id	string	Optional	—
allowed_ips	string[]	Optional	—

typeAPIKeyList7 fields

Field	Type	Requirement	Description
id	string	Optional	—
title	string	Required	Descriptive label that identifies the purpose or owner of this API key. Mobile App Dashboard Integration CI Pipeline
prefix	string	Required	—
key	string	Optional	The API key value used for authentication. Leave blank to have it generated automatically on save. Store this value securely.
allowed_ips	string[]	Required	—
created	string	Required	—
updated	string	Required	—

C

typeChangePasswordRequest3 fields

Field	Type	Requirement	Description
old_password	string	Required	—
new_password1	string	Required	—
new_password2	string	Required	—

enumCheckoutStatusEnum0 fields

* `not_required` - Not required * `initializing` - Initializing * `ready` - Ready * `failed` - Failed

No configurable fields.

typeCity7 fields

Field	Type	Requirement	Description
id	string	Optional	—
code	string	Required	Raw city code as it appears in the source data. los_angeles paris
name	string	Required	English display name of the city used across the admin and API responses.
country	LocationCountrySummary	Required	—
region	LocationRegionSummary	Required	—
isps	LocationCodeName[]	Required	—
asns	LocationCodeName[]	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

enumCommissionTypeEnum0 fields

* `flexible` - Flexible * `percentage` - Percentage * `fixed` - Fixed

No configurable fields.

typeConnectionRecord4 fields

Field	Type	Requirement	Description
user_id	string	Required	—
package_id	string	Required	—
connections	number	Required	—
server_ip	string	Required	—

typeConnectionsResponse4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Required	—
previous	string	Required	—
results	ConnectionRecord[]	Required	—

typeContinent3 fields

Field	Type	Requirement	Description
id	string	Optional	—
code	string	Required	Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr
name	string	Required	English display name of the country used across the admin and API responses.

typeCountry6 fields

Field	Type	Requirement	Description
id	string	Optional	—
code	string	Required	Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr
name	string	Required	English display name of the country used across the admin and API responses.
original_name	string	Optional	Native-language name of the country as it appears in the source data. Deutschland Français
isps	LocationCodeName[]	Required	—
asns	LocationCodeName[]	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeCoupon16 fields

Field	Type	Requirement	Description
id	string	Optional	—
redeemed_count	number	Required	—
is_expired	boolean	Required	—
is_redeemed	boolean	Required	—
packages	PackageShort[]	Required	—
stats	CouponStats	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	—
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.

typeCouponCalculatePriceRequest3 fields

Field	Type	Requirement	Description
package_id	string	Optional	—
coupon_code	string	Required	—
data	number	Required	—

typeCouponCreateRequest9 fields

Field	Type	Requirement	Description
value	number	Required	Arbitrary coupon value
code	string	Optional	Leave empty to auto-generate a 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.
marketer	string	Optional	The marketer who owns this coupon. Required if is_marketer is true.
type	CouponTypeEnum	Required	—
limit	number	Optional	Number of times coupon can be used
valid_until	string	Optional	Leave empty for coupons that never expire
packages	string[]	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

typeCouponPriceResponse3 fields

Field	Type	Requirement	Description
price_original	number	Required	Original price in the service's smallest currency unit.
price_discounted	number	Required	Price after applying the coupon, in the smallest currency unit.
discount_percentage	number	Required	—

typeCouponRedeem7 fields

Field	Type	Requirement	Description
id	string	Optional	—
user	string	Required	—
invoice	string	Optional	—
invoice_amount	number	Required	—
discount_applied	number	Required	—
redeemed_at	string	Optional	—
created	string	Required	—

typeCouponShort14 fields

Field	Type	Requirement	Description
id	string	Optional	—
is_expired	boolean	Required	—
is_redeemed	boolean	Required	—
packages	PackageShort[]	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	—
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.

typeCouponStats5 fields

Field	Type	Requirement	Description
total_redeems	number	Required	—
unique_users	number	Required	—
total_revenue	number	Required	—
total_discount_given	number	Required	—
total_data_given	number	Required	—

enumCouponTypeEnum0 fields

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

No configurable fields.

typeCouponUpdateRequest9 fields

Field	Type	Requirement	Description
value	number	Required	Arbitrary coupon value
code	string	Optional	Coupon code cannot be changed if already set
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.
marketer	string	Optional	The marketer who owns this coupon. Required if is_marketer is true.
type	CouponTypeEnum	Required	—
limit	number	Optional	Number of times coupon can be used
valid_until	string	Optional	Leave empty for coupons that never expire
packages	string[]	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

D

typeDataLedger6 fields

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.

Field	Type	Requirement	Description
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	—

typeDomainRecord3 fields

Field	Type	Requirement	Description
hostname	string	Required	—
requests	number	Required	—
data	number	Required	—

typeDomainsResponse6 fields

Field	Type	Requirement	Description
next	string	Required	—
previous	string	Required	—
timezone	string	Required	—
start	string	Required	—
end	string	Required	—
results	DomainRecord[]	Required	—

E

typeEnabledResponse1 fields

Field	Type	Requirement	Description
enabled	boolean	Required	—

F

typeFeedRecord20 fields

Field	Type	Requirement	Description
id	string	Required	Exact decimal UInt64 identifier, normalized from the API's JSON number.
established_connections	number	Required	—
reseller_id	string	Required	—
user_id	string	Required	—
package_id	string	Required	—
ledger_id	string	Required	—
username	string	Required	—
user_ip	string	Required	—
server_ip	string	Required	—
data	number	Required	—
hostname	string	Required	—
protocol	string	Required	—
method	string	Required	—
pool	string	Required	—
is_session	boolean	Required	—
country	string	Required	—
region	string	Required	—
city	string	Required	—
asn	string	Required	—
timestamp	string	Required	—

typeFeedResponse7 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Required	—
previous	string	Required	—
timezone	string	Required	—
start	string	Required	—
end	string	Required	—
results	FeedRecord[]	Required	—

enumFreshnessEnum0 fields

* `fresh` - fresh * `stale` - stale * `unavailable` - unavailable

No configurable fields.

G

typeGeneratedProxy6 fields

Field	Type	Requirement	Description
host	string	Required	—
port	number	Required	—
protocol	string	Required	—
username	string	Required	—
password	string	Required	—
connection_string	string	Required	—

typeGenerateProxyRequest6 fields

Validates proxy generation request data and builds generator config.

Field	Type	Requirement	Description
package_id	string	Required	ProxyRequest package UUID used to generate credentials. Headless integrations must resolve this from their local product mapping.
user_id	string	Optional	ProxyRequest sub-user UUID that will use the generated credentials. Resolve it from your local customer mapping. Must be the caller's own sub-user, even for superusers. Omit to generate for the authenticated account. For an independent top-level customer, authenticate as that customer rather than sending its ID with a global key.
quantity	number	Required	Number of proxies to generate
targeting	ProxyGenerationTargetingRequest	Optional	—
connection	ProxyGenerationConnectionRequest	Optional	—
session	ProxyGenerationSessionRequest	Optional	—

typeGenerateProxyResponse2 fields

Field	Type	Requirement	Description
count	number	Required	—
proxies	GeneratedProxy[]	Required	—

typeGoogleAuthRequest5 fields

Enhanced Google OAuth authentication with comprehensive security validation and user management.

Field	Type	Requirement	Description
credential	string	Required	Google ID token credential
client_id	string	Optional	Google OAuth client ID
select_by	string	Optional	User selection method
affiliate_code	string	Optional	Optional affiliate code
referral_code	string	Optional	Optional referral code

I

typeInvoice38 fields

Field	Type	Requirement	Description
id	string	Optional	—
package	PackageShort	Required	—
country	Country	Required	—
user_id	string	Required	—
coupon	CouponShort	Required	—
payment_amount	number	Required	—
payment_currency	string	Required	—
fx_market_rate	string	Required	—
fx_effective_rate	string	Required	—
fx_markup_percent	string	Required	—
fx_quoted_at	string	Required	—
updated	string	Required	—
created	string	Required	—
type	InvoiceTypeEnum	Optional	The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance
is_one_time	boolean	Optional	Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.
is_payout	boolean	Optional	Indicates whether this invoice is a payout to the marketer. Default is False.
internal_id	string	Optional	A unique identifier for the invoice, generated automatically.
status	InvoiceStatusEnum	Optional	Payment state. A paid package invoice funds an order; a paid balance invoice credits money. Confirm the resulting order before delivering access, because fulfillment can recover asynchronously. Creating an invoice with status=paid requires a superuser. This read field is not a public status-update or refund endpoint. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
description	string	Optional	A description of the invoice. This field is optional and can be left blank.
connection_limit	number	Optional	The maximum number of concurrent connections allowed for this package.
quantity	number	Optional	The number of proxies to assign.
data	number	Optional	The amount of data in bytes.
balance	number	Optional	The balance to top up for the user. Must be zero or positive.
price_total	number	Optional	The total price of the invoice, including any discounts. Must be at least 1 cent.
gateway	InvoiceGatewayEnum	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
payment_url	string	Optional	The URL for making the payment. Optional field with a maximum length of 500 characters.
currency	string	Optional	ISO 4217 currency captured when the invoice is created.
provider_checkout_id	string	Optional	Provider-side hosted checkout identifier used for reconciliation.
provider_payment_id	string	Optional	Provider-side payment or transaction identifier used for reconciliation.
checkout_status	CheckoutStatusEnum	Optional	—
vat	number	Optional	The VAT percentage applied to the invoice. Must be between 0 and 100.
company_name	string	Optional	—
company_address	string	Optional	—
company_city	string	Optional	—
company_postal_code	string	Optional	—
company_registration_number	string	Optional	—
company_vat_number	string	Optional	—
paid	string	Optional	The date and time when the invoice was paid.

enumInvoiceCreateRequestGatewayEnum0 fields

* `crypto` - crypto * `credit_card` - credit_card * `wallet` - wallet * `manual` - manual * `stripe` - stripe * `coinbase` - coinbase * `cryptomus` - cryptomus * `coingate` - coingate * `whitepay` - whitepay * `wayforpay` - wayforpay * `usegateway` - usegateway * `binance` - binance * `anymoney` - anymoney * `coinpayments` - coinpayments * `checkoutcom` - checkoutcom * `nowpayments` - nowpayments * `btcpay` - btcpay * `braintree` - braintree * `monobank` - monobank * `liqpay` - liqpay * `iyzico` - iyzico * `paytr` - paytr * `payu` - payu * `tpay` - tpay * `przelewy24` - przelewy24 * `gopay` - gopay * `comgate` - comgate * `monei` - monei * `redsys` - redsys * `payplug` - payplug * `mollie` - mollie * `unzer` - unzer * `payone` - payone * `nexi_xpay` - nexi_xpay * `halyk_epay` - halyk_epay * `kaspi_pay` - kaspi_pay * `vipps_mobilepay` - vipps_mobilepay * `paytrail` - paytrail

No configurable fields.

typeInvoiceCreateRequestRequest16 fields

Field	Type	Requirement	Description
package_id	string	Optional	Package to purchase. Required for package purchases.
user_id	string	Optional	Account receiving the purchase. Omit for your own account. Sending user_id requires is_reseller; a reseller can target its own sub-user, while a superuser with is_reseller can target another account. Do not send your own ID.
gateway	InvoiceCreateRequestGatewayEnum	Required	—
status	InvoiceCreateRequestStatusEnum	Optional	Initial invoice status. Defaults to pending. Setting paid requires a superuser or an active superuser's API key, including requests using X-Impersonate-User. Other authenticated users receive a 403 response. * `pending` - pending * `paid` - paid
crypto_currency	string	Optional	—
payment_currency	string	Optional	ISO 4217 currency charged by a regional fiat provider.
coupon_code	string	Optional	—
country_code	string	Optional	—
data	number	Optional	Residential proxy data to purchase, in integer bytes (1 GiB = 1073741824). Required with package_id for a residential purchase. A paid purchase funds the recipient's order; it is not a virtual allocation from a parent pool.
quantity	number	Optional	Number of static proxies to purchase.
amount	number	Optional	Account balance amount to purchase, in the smallest currency unit. Use for a wallet top-up without package_id, not for buying proxy data.
connection_limit	number	Optional	—
expires	number	Optional	Optional future expiration as a Unix timestamp in seconds, not milliseconds. Otherwise a positive package billing cycle determines the purchased data's expiration from the payment date; a zero cycle has no automatic expiration. A later purchase does not extend earlier finite, expiring ledgers.
company_name	string	Optional	—
company_registration_number	string	Optional	—
company_vat_number	string	Optional	—

enumInvoiceCreateRequestStatusEnum0 fields

* `pending` - pending * `paid` - paid

No configurable fields.

enumInvoiceGatewayEnum0 fields

* `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail

No configurable fields.

typeInvoiceRead39 fields

Full invoice in package-based deployments; short invoice otherwise. Invoice creation always returns the full Invoice representation.

Field	Type	Requirement	Description
id	string	Optional	—
package	PackageShort	Required	—
country	Country	Required	—
user_id	string	Required	—
coupon	Coupon	Required	—
payment_amount	number	Required	—
payment_currency	string	Required	—
fx_market_rate	string	Required	—
fx_effective_rate	string	Required	—
fx_markup_percent	string	Required	—
fx_quoted_at	string	Required	—
updated	string	Required	—
created	string	Required	—
type	InvoiceTypeEnum	Optional	The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance
is_one_time	boolean	Optional	Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.
is_payout	boolean	Optional	Indicates whether this invoice is a payout to the marketer. Default is False.
internal_id	string	Optional	A unique identifier for the invoice, generated automatically.
status	InvoiceStatusEnum	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
description	string	Optional	A description of the invoice. This field is optional and can be left blank.
connection_limit	number	Optional	The maximum number of concurrent connections allowed for this package.
quantity	number	Optional	The number of proxies to assign.
data	number	Optional	The amount of data in bytes.
balance	number	Optional	The balance to top up for the user. Must be zero or positive.
price_total	number	Optional	The total price of the invoice, including any discounts. Must be at least 1 cent.
gateway	InvoiceGatewayEnum	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
payment_url	string	Optional	The URL for making the payment. Optional field with a maximum length of 500 characters.
currency	string	Optional	ISO 4217 currency captured when the invoice is created.
provider_checkout_id	string	Optional	Provider-side hosted checkout identifier used for reconciliation.
provider_payment_id	string	Optional	Provider-side payment or transaction identifier used for reconciliation.
checkout_status	CheckoutStatusEnum	Optional	—
vat	number	Optional	The VAT percentage applied to the invoice. Must be between 0 and 100.
company_name	string	Optional	—
company_address	string	Optional	—
company_city	string	Optional	—
company_postal_code	string	Optional	—
company_registration_number	string	Optional	—
company_vat_number	string	Optional	—
paid	string	Optional	The date and time when the invoice was paid.
expires	string	Optional	The date and time when the invoice expires. If not set, the invoice does not expire.

typeInvoiceShort28 fields

Field	Type	Requirement	Description
id	string	Optional	—
coupon	Coupon	Required	—
country	Country	Required	—
updated	string	Required	—
created	string	Required	—
is_one_time	boolean	Optional	Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.
is_payout	boolean	Optional	Indicates whether this invoice is a payout to the marketer. Default is False.
internal_id	string	Optional	A unique identifier for the invoice, generated automatically.
status	InvoiceStatusEnum	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
description	string	Optional	A description of the invoice. This field is optional and can be left blank.
connection_limit	number	Optional	The maximum number of concurrent connections allowed for this package.
data	number	Optional	The amount of data in bytes.
balance	number	Optional	The balance to top up for the user. Must be zero or positive.
price_total	number	Optional	The total price of the invoice, including any discounts. Must be at least 1 cent.
gateway	InvoiceGatewayEnum	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
currency	string	Optional	ISO 4217 currency captured when the invoice is created.
provider_checkout_id	string	Optional	Provider-side hosted checkout identifier used for reconciliation.
provider_payment_id	string	Optional	Provider-side payment or transaction identifier used for reconciliation.
checkout_status	CheckoutStatusEnum	Optional	—
vat	number	Optional	The VAT percentage applied to the invoice. Must be between 0 and 100.
company_name	string	Optional	—
company_address	string	Optional	—
company_city	string	Optional	—
company_postal_code	string	Optional	—
company_registration_number	string	Optional	—
company_vat_number	string	Optional	—
paid	string	Optional	The date and time when the invoice was paid.
expires	string	Optional	The date and time when the invoice expires. If not set, the invoice does not expire.

enumInvoiceStatusEnum0 fields

* `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error

No configurable fields.

enumInvoiceTypeEnum0 fields

* `static` - Static * `residential` - Residential * `balance` - Balance

No configurable fields.

typeISP2 fields

Field	Type	Requirement	Description
code	string	Required	Unique internal code used to identify this ISP in location vocabulary entries and provider routing rules. comcast att deutsche_telekom
name	string	Required	Full display name of the Internet Service Provider. Comcast Cable Communications AT&T Services

L

enumLanguageEnum0 fields

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

No configurable fields.

enumLevelEnum0 fields

* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond

No configurable fields.

typeLocationASNGeoItem3 fields

Field	Type	Requirement	Description
country	LocationCodeName	Required	—
region	LocationCodeName	Optional	—
city	LocationCodeName	Optional	—

typeLocationASNRecord3 fields

Field	Type	Requirement	Description
code	string	Required	—
name	string	Required	—
geo	LocationASNGeoItem[]	Optional	—

typeLocationCodeName2 fields

Field	Type	Requirement	Description
code	string	Required	—
name	string	Required	—

typeLocationCountrySummary3 fields

Field	Type	Requirement	Description
code	string	Required	—
name	string	Required	—
original_name	string	Optional	—

typeLocationRegionSummary3 fields

Field	Type	Requirement	Description
code	string	Required	—
name	string	Required	—
original_name	string	Optional	—

typeLoginRequestRequest3 fields

Field	Type	Requirement	Description
email	string	Optional	Account email. Send either email or username.
username	string	Optional	Account username. Send either username or email.
password	string	Required	Current account password.

typeLogRecord22 fields

Field	Type	Requirement	Description
id	number	Required	—
server_ip	string	Required	—
user_ip	string	Required	—
protocol	string	Required	—
method	string	Required	—
user_id	string	Required	—
reseller_id	string	Required	—
username	string	Required	—
hostname	string	Required	—
status_code	number	Required	—
error_code	number	Required	—
error_message	string	Required	—
country	string	Required	—
region	string	Required	—
city	string	Required	—
asn	string	Required	—
level	string	Required	—
is_session	boolean	Required	—
timestamp	string	Required	—
package_id	string	Optional	—
package_alias	string	Optional	—
ledger_id	string	Optional	—

typeLogsResponse7 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Required	—
previous	string	Required	—
timezone	string	Required	—
start	string	Required	—
end	string	Required	—
results	LogRecord[]	Required	—

M

typeMessageResponse1 fields

Field	Type	Requirement	Description
detail	string	Required	—

N

typeNews4 fields

Field	Type	Requirement	Description
id	string	Optional	—
title	string	Required	—
content	string	Required	The content of the news item. HTML is allowed.
date	string	Optional	The date and time when the news item is published.

enumNullEnum0 fields

No configurable fields.

O

typeOrder17 fields

Field	Type	Requirement	Description
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	—
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.
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	—

typeOrderDetailed18 fields

Field	Type	Requirement	Description
id	string	Optional	—
package	PackageShort	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.
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.

typeOTPChallenge3 fields

Field	Type	Requirement	Description
status	string	Required	—
challenge	string	Required	—
expires_in	number	Required	—

typeOverallPoint3 fields

Field	Type	Requirement	Description
data	number	Required	—
requests	number	Required	—
timestamp	string	Required	—

typeOverallResponse7 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Required	—
previous	string	Required	—
timezone	string	Required	—
start	string	Required	—
end	string	Required	—
results	OverallPoint[]	Required	—

P

typePackage19 fields

Field	Type	Requirement	Description
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
type	ProxyTypeEnum	Optional	—
order	number	Optional	Display order in the UI. Lower values appear first.
is_continent_targeting	boolean	Optional	When enabled, users on this package can target proxies by continent. If disabled, they will only be able to target by country or city.
is_country_targeting	boolean	Optional	Allow users to target a specific country in their proxy username. country-us country-de
is_region_targeting	boolean	Optional	Allow users to target a specific region in their proxy username. Requires country targeting to be enabled. country-us-region-california
is_city_targeting	boolean	Optional	Allow users to target a specific city in their proxy username. Requires country and region targeting to be enabled. country-us-region-california-city-los_angeles
is_asn_targeting	boolean	Optional	Allow users to target a specific ASN in their proxy username. ASNs must be configured in the provider's location vocabulary. country-us-asn-3602
features	string[]	Required	—
description	string	Optional	Customer-facing description shown on the package listing page.
pricing	PricingEnum	Optional	Pricing model applied when customers purchase data on this package. Fixed a fixed price per data amount — 10 GB for $10, 50 GB for $50 Range tiered pricing where the unit price decreases as quantity increases * `fixed` - Fixed * `range` - Range
pricing_unit	PricingUnitEnum	Optional	Unit customers purchase — determines how the billing model amounts are interpreted. * `data` - Data * `proxy` - Proxy
billing_cycle	number	Required	Number of days before purchased data expires. Set to -1 for data that never expires. 30 monthly -1 never expires
billing_model	Record<string, unknown>	Required	—
commission_rate	string	Optional	Reseller commission rate as a percentage of the sale price. Applies to all purchases of this package. 10.00 → 10 percent commission on every purchase
commission_type	CommissionTypeEnum	Optional	How the commission rate is applied to reseller sales. Fixed a fixed percentage regardless of sale amount Flexible rate may vary based on negotiated reseller terms * `flexible` - Flexible * `percentage` - Percentage * `fixed` - Fixed
targeting_options	TargetingOptions	Required	—

typePackageCommission8 fields

Field	Type	Requirement	Description
id	string	Required	—
name	string	Required	—
pricing	string	Required	—
commission_rate	number	Required	—
total_earnings	number	Required	—
total_orders	number	Required	—
pending	number	Required	—
billing_model	string	Required	—

typePackageShort5 fields

Field	Type	Requirement	Description
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	—

typePaginatedAffiliateList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	Affiliate[]	Required	—

typePaginatedAffiliateRewardList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	AffiliateReward[]	Required	—

typePaginatedAPIKeyListList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	APIKeyList[]	Required	—

typePaginatedCityList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	City[]	Required	—

typePaginatedContinentList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	Continent[]	Required	—

typePaginatedCountryList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	Country[]	Required	—

typePaginatedCouponRedeemList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	CouponRedeem[]	Required	—

typePaginatedCouponShortList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	CouponShort[]	Required	—

typePaginatedInvoiceReadList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	InvoiceRead[]	Required	—

typePaginatedISPList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	ISP[]	Required	—

typePaginatedLocationASNRecordList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	LocationASNRecord[]	Required	—

typePaginatedNewsList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	News[]	Required	—

typePaginatedOrderList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	Order[]	Required	—

typePaginatedPackageCommissionList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	PackageCommission[]	Required	—

typePaginatedPackageList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	Package[]	Required	—

typePaginatedProviderDataBalanceList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	ProviderDataBalance[]	Required	—

typePaginatedRegionList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	Region[]	Required	—

typePaginatedRewardList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	Reward[]	Required	—

typePaginatedUserList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	User[]	Required	—

typePaginatedWebhookListList4 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Optional	—
previous	string	Optional	—
results	WebhookList[]	Required	—

typePasswordRecoveryResponse2 fields

Field	Type	Requirement	Description
message	string	Required	—
email	string	Required	—

typePatchedCouponUpdateRequest9 fields

Field	Type	Requirement	Description
value	number	Optional	Arbitrary coupon value
code	string	Optional	Coupon code cannot be changed if already set
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.
marketer	string	Optional	The marketer who owns this coupon. Required if is_marketer is true.
type	CouponTypeEnum	Optional	—
limit	number	Optional	Number of times coupon can be used
valid_until	string	Optional	Leave empty for coupons that never expire
packages	string[]	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

typePatchedOrderAutoRenewalRequest2 fields

Field	Type	Requirement	Description
auto_renewal_percentage	number	Optional	—
auto_renewal_data	number	Optional	—

typePatchedProfileUpdateRequest18 fields

for updating user profile information with comprehensive validation. Handles personal profile data, company information, security settings, and password changes. All fields are optional, but at least one field must be provided for the update to be valid. Includes validation for domain patterns with support for wildcards (*.example.com) and subdomains.

Field	Type	Requirement	Description
email	string	Optional	—
first_name	string	Optional	—
last_name	string	Optional	—
country	string	Optional	—
state	string	Optional	—
city	string	Optional	—
address	string	Optional	—
zip	string	Optional	—
company_name	string	Optional	—
company_country	string	Optional	—
company_city	string	Optional	—
company_address	string	Optional	—
company_postal_code	string	Optional	—
company_vat_number	string	Optional	—
blocked_domains	string[]	Optional	—
allowed_ips	string[]	Optional	—
new_password	string	Optional	—
old_password	string	Optional	—

typePatchedTelegramConnectionUpdateRequest2 fields

Field	Type	Requirement	Description
locale	string	Optional	—
timezone	string	Optional	—

typePatchedUserUpdateRequest20 fields

Optional fields accepted when updating part of an existing customer account.

Field	Type	Requirement	Description
email	string	Optional	User's email address. Must be unique across the system.
first_name	string	Optional	User's first name.
last_name	string	Optional	User's last name.
country	string	Optional	User's country of residence.
state	string	Optional	User's state or province.
city	string	Optional	User's city.
address	string	Optional	User's street address.
zip	string	Optional	User's postal/ZIP code.
company_name	string	Optional	Name of the user's company.
company_country	string	Optional	Country where the company is located.
company_city	string	Optional	City where the company is located.
company_address	string	Optional	Company's street address.
company_postal_code	string	Optional	Company's postal code.
company_vat_number	string	Optional	Company's VAT number.
is_reseller	boolean	Optional	Whether the user has reseller privileges. Only superusers can modify.
blocked_domains	string[]	Optional	List of domains to block for this user.
allowed_ips	string[]	Optional	List of source IP addresses allowed for this user. The maximum list size is configured per deployment.
connection_limit	number	Optional	Maximum number of concurrent connections allowed for the user.
new_password	string	Optional	New password for the user. Must be 8-128 characters long.
meta	Record<string, unknown>	Optional	Additional metadata for the user. Maximum 50 fields.

typePaymentGateway6 fields

Field	Type	Requirement	Description
code	string	Required	—
name	string	Required	—
kind	string	Required	—
supported_currencies	string[]	Required	—
supported_crypto_currencies	string[]	Required	—
requires_crypto_currency	boolean	Required	—

typePaymentLinkResponse1 fields

Field	Type	Requirement	Description
payment_url	string	Required	Hosted checkout URL for the pending invoice.

enumPricingEnum0 fields

* `fixed` - Fixed * `range` - Range

No configurable fields.

enumPricingUnitEnum0 fields

* `data` - Data * `proxy` - Proxy

No configurable fields.

enumProtocolEnum0 fields

* `http` - http * `socks5` - socks5 * `auto` - auto

No configurable fields.

typeProviderBalanceCheckpoint5 fields

Field	Type	Requirement	Description
id	string	Required	—
available_bytes	string	Required	Observed balance in bytes, as a decimal string.
observed_at	string	Required	—
created	string	Required	—
created_by	string	Required	—

typeProviderDataBalance13 fields

Field	Type	Requirement	Description
checkpoint_id	string	Required	—
provider_id	string	Required	—
provider_name	string	Required	—
observed_at	string	Required	Time the available balance was observed.
available_bytes	string	Required	Observed balance in bytes, as a decimal string.
used_bytes	string	Required	Calculated usage since the observation, in bytes.
remaining_bytes	string	Required	Remaining bytes at calculated_at, as a decimal string.
remaining_percent	number	Required	—
severity	SeverityEnum | NullEnum	Required	—
freshness	FreshnessEnum	Required	—
error	string	Required	—
calculated_at	string	Required	Time of the last successful calculation.
history	ProviderBalanceCheckpoint[]	Required	Latest entries by creation time, limited by PROVIDER_DATA_BALANCE_HISTORY_LIMIT (default 10).

typeProxyGenerationConnectionRequest4 fields

Field	Type	Requirement	Description
protocol	ProtocolEnum	Optional	Proxy protocol. * `http` - http * `socks5` - socks5 * `auto` - auto
host	string	Optional	Gateway host. Leave empty to choose one available gateway for the entire request.
port	number	Optional	Gateway port. Leave empty to use the port for the selected protocol.
format	string	Optional	Connection string format.

typeProxyGenerationSessionRequest1 fields

Field	Type	Requirement	Description
ttl	number	Optional	Sticky session lifetime in seconds. The accepted range is configured per deployment.

typeProxyGenerationTargetingRequest8 fields

Field	Type	Requirement	Description
continent	string	Optional	Target continent code.
country	string	Optional	Target country code.
region	string	Optional	Target region or state code.
city	string	Optional	Target city code.
pool	string	Optional	Proxy pool identifier.
asn	number	Optional	Target autonomous system number.
isp	string	Optional	Target internet service provider.
os	string	Optional	Target operating system: linux, windows, ios, macos, android. Use comma-separated values only when combined OS targeting is enabled.

typeProxyPasswordResetResponse2 fields

Field	Type	Requirement	Description
message	string	Required	—
success	boolean	Required	—

enumProxyTypeEnum0 fields

* `static` - Static * `residential` - Residential

No configurable fields.

R

typeRecoverPasswordRequest2 fields

Password recovery with enhanced security and comprehensive error handling.

Field	Type	Requirement	Description
email	string	Required	Email address for password recovery
token	string	Required	Cloudflare Turnstile security token

typeRegion8 fields

Field	Type	Requirement	Description
id	string	Optional	—
code	string	Required	Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france
iso31662	string	Optional	ISO 3166-2 subdivision code for this region. US-CA FR-IDF
name	string	Required	English display name of the region used across the admin and API responses.
original_name	string	Optional	Native-language name of the region as it appears in the source data.
country	LocationCountrySummary	Required	—
isps	LocationCodeName[]	Required	—
asns	LocationCodeName[]	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeResetDataRequest1 fields

Field	Type	Requirement	Description
package_id	string	Required	Package whose remaining data is reset to zero.

typeResetPasswordRequest1 fields

Field	Type	Requirement	Description
order_id	string	Required	—

typeReward8 fields

Field	Type	Requirement	Description
id	string	Optional	—
email	string	Required	—
created	string	Required	—
balance	number	Optional	—
data	number	Optional	The amount of data in bytes.
status	RewardStatusEnum	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled
description	string	Optional	Description of the reward, used to include payout details.
level	LevelEnum	Optional	—

typeRewardClaimRequestRequest2 fields

Field	Type	Requirement	Description
type	string	Required	Reward balance to claim, for example balance or data.
description	string	Optional	Optional note stored with the claim.

enumRewardStatusEnum0 fields

* `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled

No configurable fields.

S

typeSettingsCrypto1 fields

Field	Type	Requirement	Description
currencies	string[]	Required	—

typeSettingsGateway9 fields

Field	Type	Requirement	Description
id	string	Required	—
name	string	Required	—
region	string	Required	—
hostname	string	Required	Cluster gateway domain, or a server IP when no domain is configured.
hostnames	string[]	Required	The cluster domain, or unique server IPs when no domain is configured.
port_http	number	Required	—
port_socks5	number	Required	—
port_auto	number	Required	—
port_haproxy	number	Required	—

typeSettingsReferral4 fields

Field	Type	Requirement	Description
reward_balance_percentage	number	Required	—
reward_data_percentage	number	Required	—
reward_min_balance	number	Required	—
reward_min_data	number	Required	—

typeSettingsResponse10 fields

Field	Type	Requirement	Description
gateways	SettingsGateway[]	Required	—
spent_total	number	Required	—
orders_total	number	Required	—
orders_active	number	Required	—
data_available	number	Required	—
data_spent	number	Required	—
referrals	SettingsReferral	Required	—
crypto	SettingsCrypto	Required	—
payment_methods	string[]	Required	—
payment_gateways	PaymentGateway[]	Required	—

enumSeverityEnum0 fields

* `warning` - warning * `danger` - danger

No configurable fields.

typeSignUpRequest5 fields

Comprehensive user registration with enhanced validation, security measures, and referral/affiliate code handling.

Field	Type	Requirement	Description
email	string	Required	Valid email address for account creation
password	string	Required	Strong password meeting security requirements
token	string	Required	Cloudflare Turnstile security token
affiliate_code	string	Optional	Optional affiliate referral code
referral_code	string	Optional	Optional user referral code

typeSubtractDataRequest2 fields

Field	Type	Requirement	Description
package_id	string	Required	Package of the managed virtual child order.
data	number	Required	Positive integer bytes to remove from assigned quota, not from usage. Cannot exceed total assigned data. Does not credit the parent's pool.

T

typeTargetingOptions25 fields

Field	Type	Requirement	Description
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	—

typeTelegramConnectionResponse8 fields

Field	Type	Requirement	Description
available	boolean	Required	—
status	string	Required	—
bot_username	string	Required	—
telegram_username	string	Optional	—
locale	string	Required	—
timezone	string	Required	—
linked_at	string	Optional	—
pending_expires_at	string	Optional	—

typeTelegramLinkResponse3 fields

Field	Type	Requirement	Description
status	string	Required	—
bot_url	string	Required	—
expires_at	string	Required	—

typeTokenPairResponse2 fields

Field	Type	Requirement	Description
token	string	Required	Short-lived access token used in the Authorization header.
refresh	string	Required	Long-lived token used to request a new access token.

typeTokenRefreshRequestRequest1 fields

Field	Type	Requirement	Description
refresh	string	Required	A valid refresh token.

typeTokenRefreshResponse1 fields

Field	Type	Requirement	Description
access	string	Required	New access token for the same account session.

typeTransactionRecord8 fields

Field	Type	Requirement	Description
sender_uuid	string	Required	—
recipient_uuid	string	Required	—
type	number	Required	—
amount	number	Required	—
package_uuid	string	Required	—
details	string	Required	—
date	string	Required	—
timestamp	string	Required	—

typeTransactionsResponse7 fields

Field	Type	Requirement	Description
count	number	Required	—
next	string	Required	—
previous	string	Required	—
timezone	string	Required	—
start	string	Required	—
end	string	Required	—
results	TransactionRecord[]	Required	—

typeTwoFactorConfirmRequest1 fields

Field	Type	Requirement	Description
code	string	Required	—

typeTwoFactorDisableRequest3 fields

Field	Type	Requirement	Description
password	string	Optional	—
credential	string	Optional	—
code	string	Required	—

typeTwoFactorSetupRequestRequest3 fields

Field	Type	Requirement	Description
password	string	Optional	—
credential	string	Optional	—
code	string	Optional	—

typeTwoFactorSetupResponse3 fields

Field	Type	Requirement	Description
secret	string	Required	—
otpauth_url	string	Required	—
qr_png_base64	string	Optional	—

U

typeUser43 fields

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

Field	Type	Requirement	Description
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	—
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
coupons	CouponShort[]	Required	Available coupons for this user
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.

typeUserCreateRequest18 fields

Fields accepted when a reseller or administrator creates a customer account.

Field	Type	Requirement	Description
email	string	Optional	User's email address. Must be unique if provided.
username	string	Required	Unique username for the account. Must be 4-128 characters.
password	string	Required	Account password. Must be 8-128 characters long.
first_name	string	Optional	User's first name.
last_name	string	Optional	User's last name.
country	string	Optional	User's country of residence.
state	string	Optional	User's state or province.
city	string	Optional	User's city.
address	string	Optional	User's street address.
zip	string	Optional	User's postal/ZIP code.
blocked_domains	string[]	Optional	List of domains to block for this user.
allowed_ips	string[]	Optional	List of source IP addresses allowed for this user. The maximum list size is configured per deployment.
connection_limit	number	Optional	Maximum number of concurrent connections allowed for the user.
is_reseller	boolean	Optional	Whether the user should have reseller privileges. Only superusers can create resellers.
is_top_level	boolean	Optional	Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.
data	number	Optional	Initial integer-byte data amount. With package_id, a normal sub-user receives a virtual quota from the caller's existing root order; is_top_level=true provisions a separate paid purchase. Omit both data and package_id to create identity without package access.
package_id	string	Optional	ProxyRequest package UUID to assign to the user. Headless integrations resolve it from their local product mapping.
meta	Record<string, unknown>	Optional	Additional metadata for the user. Maximum 50 fields.

typeUserCurrency2 fields

Field	Type	Requirement	Description
code	string	Required	—
symbol	string	Required	—

typeUserPasswordResetRequestRequest1 fields

Field	Type	Requirement	Description
package_id	string	Optional	Package whose order's proxy password should be rotated.

V

typeVerifyOTPRequest2 fields

Field	Type	Requirement	Description
challenge	string	Required	—
code	string	Required	—

W

typeWebhookCreated9 fields

Field	Type	Requirement	Description
id	string	Optional	—
type	WebhookScopeEnum	Optional	Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System
endpoint	string	Required	HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.
secret	string	Optional	Secret used to sign each webhook payload. The receiving endpoint should verify the signature to confirm the request originated from this platform. Auto-generated if left blank. Store this value securely on the receiving end.
read_timeout	number	Optional	Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.
write_timeout	number	Optional	Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.
retries	number	Optional	Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts
retry_timeout	number	Optional	How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds
created	string	Required	—

typeWebhookCreateRequest6 fields

Field	Type	Requirement	Description
type	WebhookScopeEnum	Required	—
endpoint	string	Required	—
read_timeout	number	Optional	—
write_timeout	number	Optional	—
retries	number	Optional	—
retry_timeout	number	Optional	—

typeWebhookList8 fields

Field	Type	Requirement	Description
id	string	Optional	—
type	WebhookScopeEnum	Optional	Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System
endpoint	string	Required	HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.
read_timeout	number	Optional	Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.
write_timeout	number	Optional	Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.
retries	number	Optional	Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts
retry_timeout	number	Optional	How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds
created	string	Required	—

enumWebhookScopeEnum0 fields

* `user` - User * `reseller` - Reseller * `system` - System

No configurable fields.

Filter 155 models

A

classAPIKeyCreate5 fields

Field	Type	Requirement	Description
title	str	Required	—
key	str	Required	—
created	datetime.datetime	Required	—
id	str	Optional	—
allowed_ips	list[str]	Optional	—

classAPIKeyCreateRequest2 fields

Field	Type	Requirement	Description
id	str	Optional	—
allowed_ips	list[str]	Optional	—

classAPIKeyList7 fields

Field	Type	Requirement	Description
title	str	Required	Descriptive label that identifies the purpose or owner of this API key. Mobile App Dashboard Integration CI Pipeline
prefix	str	Required	—
allowed_ips	list[str]	Required	—
created	datetime.datetime	Required	—
updated	datetime.datetime	Required	—
id	str	Optional	—
key	str	Optional	The API key value used for authentication. Leave blank to have it generated automatically on save. Store this value securely.

classAddDataRequest2 fields

Field	Type	Requirement	Description
package_id	UUID	Required	Package for which the caller owns a root order.
data	int	Required	Positive integer bytes to add to the child's assigned quota. Does not reserve parent data; may exceed the parent's remaining pool.

classAffiliate5 fields

Field	Type	Requirement	Description
email	str	Required	—
id	UUID	Optional	—
signup_ip	None | str	Optional	IP address from which the user signed up. This field is optional and can be used for tracking purposes.
signup_country	str	Optional	Country from which the user signed up. This field is optional and can be used for tracking purposes.
date_joined	datetime.datetime	Optional	—

classAffiliateReward8 fields

Field	Type	Requirement	Description
email	str	Required	—
package	PackageShort	Required	—
price_total	int	Required	—
commission_amount	int	Required	—
created	datetime.datetime	Required	—
id	str	Optional	—
status	RewardStatusEnum	Optional	* `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled
data	int	Optional	The amount of data in bytes.

classAffiliateStatsPoint4 fields

Field	Type	Requirement	Description
date	datetime.date	Optional	—
balance	float	Optional	—
data	int	Optional	—
count	int	Optional	—

classAffiliateStatsResponse1 fields

Field	Type	Requirement	Description
results	list[AffiliateStatsPoint]	Required	—

enumAnalyticsDomainsRetrieveOrdering0 fields

No configurable fields.

enumAnalyticsFeedRetrieveProtocol0 fields

No configurable fields.

enumAnalyticsLogsRetrieveProtocol0 fields

No configurable fields.

C

classChangePasswordRequest3 fields

Field	Type	Requirement	Description
old_password	str	Required	—
new_password1	str	Required	—
new_password2	str	Required	—

enumCheckoutStatusEnum0 fields

No configurable fields.

classCity7 fields

Field	Type	Requirement	Description
code	str	Required	Raw city code as it appears in the source data. los_angeles paris
name	str	Required	English display name of the city used across the admin and API responses.
country	LocationCountrySummary	Required	—
region	LocationRegionSummary	Required	—
isps	list[LocationCodeName]	Required	—
asns	list[LocationCodeName]	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
id	str	Optional	—

enumCommissionTypeEnum0 fields

No configurable fields.

classConnectionRecord4 fields

Field	Type	Requirement	Description
user_id	UUID	Required	—
package_id	UUID	Required	—
connections	int	Required	—
server_ip	str	Required	—

classConnectionsResponse4 fields

Field	Type	Requirement	Description
count	int	Required	—
next_	None | str	Required	—
previous	None | str	Required	—
results	list[ConnectionRecord]	Required	—

classContinent3 fields

Field	Type	Requirement	Description
code	str	Required	Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr
name	str	Required	English display name of the country used across the admin and API responses.
id	str	Optional	—

classCountry6 fields

Field	Type	Requirement	Description
code	str	Required	Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr
name	str	Required	English display name of the country used across the admin and API responses.
isps	list[LocationCodeName]	Required	—
asns	list[LocationCodeName]	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
id	str	Optional	—
original_name	str	Optional	Native-language name of the country as it appears in the source data. Deutschland Français

classCoupon16 fields

Field	Type	Requirement	Description
redeemed_count	int	Required	—
is_expired	bool	Required	—
is_redeemed	bool	Required	—
packages	list[PackageShort]	Required	—
stats	CouponStats | None	Required	—
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
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.

classCouponCalculatePriceRequest3 fields

Field	Type	Requirement	Description
coupon_code	str	Required	—
data	int	Required	—
package_id	UUID	Optional	—

classCouponCreateRequest9 fields

Field	Type	Requirement	Description
value	int	Required	Arbitrary coupon value
type_	CouponTypeEnum	Required	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
code	str	Optional	Leave empty to auto-generate a code
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.
marketer	None | UUID	Optional	The marketer who owns this coupon. Required if is_marketer is true.
limit	int	Optional	Number of times coupon can be used
valid_until	datetime.datetime | None	Optional	Leave empty for coupons that never expire
packages	list[str]	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

classCouponPriceResponse3 fields

Field	Type	Requirement	Description
price_original	int	Required	Original price in the service's smallest currency unit.
price_discounted	int	Required	Price after applying the coupon, in the smallest currency unit.
discount_percentage	float	Required	—

classCouponRedeem7 fields

Field	Type	Requirement	Description
user	UUID	Required	—
invoice_amount	float | None	Required	—
discount_applied	float | None	Required	—
created	datetime.datetime	Required	—
id	str	Optional	—
invoice	None | str	Optional	—
redeemed_at	datetime.datetime | None	Optional	—

classCouponShort14 fields

Field	Type	Requirement	Description
is_expired	bool	Required	—
is_redeemed	bool	Required	—
packages	list[PackageShort]	Required	—
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
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.

classCouponStats5 fields

Field	Type	Requirement	Description
total_redeems	int	Required	—
unique_users	int	Required	—
total_revenue	int	Required	—
total_discount_given	int	Required	—
total_data_given	int	Required	—

enumCouponTypeEnum0 fields

No configurable fields.

classCouponUpdateRequest9 fields

Field	Type	Requirement	Description
value	int	Required	Arbitrary coupon value
type_	CouponTypeEnum	Required	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
code	str	Optional	Coupon code cannot be changed if already set
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.
marketer	None | UUID	Optional	The marketer who owns this coupon. Required if is_marketer is true.
limit	int	Optional	Number of times coupon can be used
valid_until	datetime.datetime | None	Optional	Leave empty for coupons that never expire
packages	list[str]	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

enumCouponsListType0 fields

No configurable fields.

enumCouponsRedeemsListType0 fields

No configurable fields.

D

classDataLedger6 fields

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.

Field	Type	Requirement	Description
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	—

classDomainRecord3 fields

Field	Type	Requirement	Description
hostname	str	Required	—
requests	int	Required	—
data	int	Required	—

classDomainsResponse6 fields

Field	Type	Requirement	Description
next_	None | str	Required	—
previous	None | str	Required	—
timezone	str	Required	—
start	datetime.datetime	Required	—
end	datetime.datetime	Required	—
results	list[DomainRecord]	Required	—

E

classEnabledResponse1 fields

Field	Type	Requirement	Description
enabled	bool	Required	—

F

classFeedRecord20 fields

Field	Type	Requirement	Description
id	int	Required	—
established_connections	int	Required	—
reseller_id	str	Required	—
user_id	str	Required	—
package_id	str	Required	—
ledger_id	str	Required	—
username	str	Required	—
user_ip	str	Required	—
server_ip	str	Required	—
data	int	Required	—
hostname	str	Required	—
protocol	str	Required	—
method	str	Required	—
pool	str	Required	—
is_session	bool	Required	—
country	str	Required	—
region	str	Required	—
city	str	Required	—
asn	str	Required	—
timestamp	datetime.datetime | None	Required	—

classFeedResponse7 fields

Field	Type	Requirement	Description
count	int	Required	—
next_	None | str	Required	—
previous	None | str	Required	—
timezone	str	Required	—
start	datetime.datetime	Required	—
end	datetime.datetime	Required	—
results	list[FeedRecord]	Required	—

enumFreshnessEnum0 fields

No configurable fields.

G

classGenerateProxyRequest6 fields

Validates proxy generation request data and builds generator config.

Field	Type	Requirement	Description
package_id	UUID	Required	ProxyRequest package UUID used to generate credentials. Headless integrations must resolve this from their local product mapping.
quantity	int	Required	Number of proxies to generate
user_id	UUID	Optional	ProxyRequest sub-user UUID that will use the generated credentials. Resolve it from your local customer mapping. Must be the caller's own sub-user, even for superusers. Omit to generate for the authenticated account. For an independent top-level customer, authenticate as that customer rather than sending its ID with a global key.
targeting	ProxyGenerationTargetingRequest	Optional	—
connection	ProxyGenerationConnectionRequest	Optional	—
session	ProxyGenerationSessionRequest	Optional	—

classGenerateProxyResponse2 fields

Field	Type	Requirement	Description
count	int	Required	—
proxies	list[GeneratedProxy]	Required	—

classGeneratedProxy6 fields

Field	Type	Requirement	Description
host	str	Required	—
port	int	Required	—
protocol	str	Required	—
username	str	Required	—
password	str	Required	—
connection_string	str	Required	—

classGoogleAuthRequest5 fields

Enhanced Google OAuth authentication with comprehensive security validation and user management.

Field	Type	Requirement	Description
credential	str	Required	Google ID token credential
client_id	str	Optional	Google OAuth client ID
select_by	str	Optional	User selection method
affiliate_code	str	Optional	Optional affiliate code
referral_code	str	Optional	Optional referral code

I

classISP2 fields

Field	Type	Requirement	Description
code	str	Required	Unique internal code used to identify this ISP in location vocabulary entries and provider routing rules. comcast att deutsche_telekom
name	str	Required	Full display name of the Internet Service Provider. Comcast Cable Communications AT&T Services

classInvoice38 fields

Field	Type	Requirement	Description
package	None | PackageShort	Required	—
country	Country | None	Required	—
user_id	UUID	Required	—
coupon	CouponShort | None	Required	—
payment_amount	int	Required	—
payment_currency	str	Required	—
fx_market_rate	str	Required	—
fx_effective_rate	str	Required	—
fx_markup_percent	str	Required	—
fx_quoted_at	datetime.datetime | None	Required	—
updated	datetime.datetime	Required	—
created	datetime.datetime	Required	—
id	str	Optional	—
type_	InvoiceTypeEnum	Optional	* `static` - Static * `residential` - Residential * `balance` - Balance
is_one_time	bool	Optional	Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.
is_payout	bool	Optional	Indicates whether this invoice is a payout to the marketer. Default is False.
internal_id	str	Optional	A unique identifier for the invoice, generated automatically.
status	InvoiceStatusEnum	Optional	* `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
description	str	Optional	A description of the invoice. This field is optional and can be left blank.
connection_limit	int	Optional	The maximum number of concurrent connections allowed for this package.
quantity	int	Optional	The number of proxies to assign.
data	int	Optional	The amount of data in bytes.
balance	int	Optional	The balance to top up for the user. Must be zero or positive.
price_total	int	Optional	The total price of the invoice, including any discounts. Must be at least 1 cent.
gateway	InvoiceGatewayEnum	Optional	* `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
payment_url	str	Optional	The URL for making the payment. Optional field with a maximum length of 500 characters.
currency	str	Optional	ISO 4217 currency captured when the invoice is created.
provider_checkout_id	str	Optional	Provider-side hosted checkout identifier used for reconciliation.
provider_payment_id	str	Optional	Provider-side payment or transaction identifier used for reconciliation.
checkout_status	CheckoutStatusEnum	Optional	* `not_required` - Not required * `initializing` - Initializing * `ready` - Ready * `failed` - Failed
vat	float	Optional	The VAT percentage applied to the invoice. Must be between 0 and 100.
company_name	str	Optional	—
company_address	str	Optional	—
company_city	str	Optional	—
company_postal_code	str	Optional	—
company_registration_number	str	Optional	—
company_vat_number	str	Optional	—
paid	datetime.datetime | None	Optional	The date and time when the invoice was paid.

classInvoiceCreateRequest16 fields

Field	Type	Requirement	Description
gateway	InvoiceCreateRequestGatewayEnum	Required	* `crypto` - crypto * `credit_card` - credit_card * `wallet` - wallet * `manual` - manual * `stripe` - stripe * `coinbase` - coinbase * `cryptomus` - cryptomus * `coingate` - coingate * `whitepay` - whitepay * `wayforpay` - wayforpay * `usegateway` - usegateway * `binance` - binance * `anymoney` - anymoney * `coinpayments` - coinpayments * `checkoutcom` - checkoutcom * `nowpayments` - nowpayments * `btcpay` - btcpay * `braintree` - braintree * `monobank` - monobank * `liqpay` - liqpay * `iyzico` - iyzico * `paytr` - paytr * `payu` - payu * `tpay` - tpay * `przelewy24` - przelewy24 * `gopay` - gopay * `comgate` - comgate * `monei` - monei * `redsys` - redsys * `payplug` - payplug * `mollie` - mollie * `unzer` - unzer * `payone` - payone * `nexi_xpay` - nexi_xpay * `halyk_epay` - halyk_epay * `kaspi_pay` - kaspi_pay * `vipps_mobilepay` - vipps_mobilepay * `paytrail` - paytrail
package_id	UUID	Optional	Package to purchase. Required for package purchases.
user_id	UUID	Optional	Account receiving the purchase. Omit for your own account. Sending user_id requires is_reseller; a reseller can target its own sub-user, while a superuser with is_reseller can target another account. Do not send your own ID.
status	InvoiceCreateRequestStatusEnum	Optional	* `pending` - pending * `paid` - paid
crypto_currency	str	Optional	—
payment_currency	str	Optional	ISO 4217 currency charged by a regional fiat provider.
coupon_code	str	Optional	—
country_code	str	Optional	—
data	int	Optional	Residential proxy data to purchase, in integer bytes (1 GiB = 1073741824). Required with package_id for a residential purchase. A paid purchase funds the recipient's order; it is not a virtual allocation from a parent pool.
quantity	int	Optional	Number of static proxies to purchase.
amount	int	Optional	Account balance amount to purchase, in the smallest currency unit. Use for a wallet top-up without package_id, not for buying proxy data.
connection_limit	int	Optional	—
expires	int	Optional	Optional future expiration as a Unix timestamp in seconds, not milliseconds. Otherwise a positive package billing cycle determines the purchased data's expiration from the payment date; a zero cycle has no automatic expiration. A later purchase does not extend earlier finite, expiring ledgers.
company_name	str	Optional	—
company_registration_number	str	Optional	—
company_vat_number	str	Optional	—

enumInvoiceCreateRequestGatewayEnum0 fields

No configurable fields.

enumInvoiceCreateRequestStatusEnum0 fields

No configurable fields.

enumInvoiceGatewayEnum0 fields

No configurable fields.

classInvoiceShort28 fields

Field	Type	Requirement	Description
coupon	Coupon | None	Required	—
country	Country | None	Required	—
updated	datetime.datetime	Required	—
created	datetime.datetime	Required	—
id	str	Optional	—
is_one_time	bool	Optional	Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.
is_payout	bool	Optional	Indicates whether this invoice is a payout to the marketer. Default is False.
internal_id	str	Optional	A unique identifier for the invoice, generated automatically.
status	InvoiceStatusEnum	Optional	* `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
description	str	Optional	A description of the invoice. This field is optional and can be left blank.
connection_limit	int	Optional	The maximum number of concurrent connections allowed for this package.
data	int	Optional	The amount of data in bytes.
balance	int	Optional	The balance to top up for the user. Must be zero or positive.
price_total	int	Optional	The total price of the invoice, including any discounts. Must be at least 1 cent.
gateway	InvoiceGatewayEnum	Optional	* `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
currency	str	Optional	ISO 4217 currency captured when the invoice is created.
provider_checkout_id	str	Optional	Provider-side hosted checkout identifier used for reconciliation.
provider_payment_id	str	Optional	Provider-side payment or transaction identifier used for reconciliation.
checkout_status	CheckoutStatusEnum	Optional	* `not_required` - Not required * `initializing` - Initializing * `ready` - Ready * `failed` - Failed
vat	float	Optional	The VAT percentage applied to the invoice. Must be between 0 and 100.
company_name	str	Optional	—
company_address	str	Optional	—
company_city	str	Optional	—
company_postal_code	str	Optional	—
company_registration_number	str	Optional	—
company_vat_number	str	Optional	—
paid	datetime.datetime | None	Optional	The date and time when the invoice was paid.
expires	datetime.datetime | None	Optional	The date and time when the invoice expires. If not set, the invoice does not expire.

enumInvoiceStatusEnum0 fields

No configurable fields.

enumInvoiceTypeEnum0 fields

No configurable fields.

enumInvoicesListPaymentGateway0 fields

No configurable fields.

enumInvoicesListStatus0 fields

No configurable fields.

enumInvoicesListType0 fields

No configurable fields.

L

enumLanguageEnum0 fields

No configurable fields.

enumLevelEnum0 fields

No configurable fields.

classLocationASNGeoItem3 fields

Field	Type	Requirement	Description
country	LocationCodeName	Required	—
region	LocationCodeName	Optional	—
city	LocationCodeName	Optional	—

classLocationASNRecord3 fields

Field	Type	Requirement	Description
code	str	Required	—
name	str	Required	—
geo	list[LocationASNGeoItem]	Optional	—

classLocationCodeName2 fields

Field	Type	Requirement	Description
code	str	Required	—
name	str	Required	—

classLocationCountrySummary3 fields

Field	Type	Requirement	Description
code	str	Required	—
name	str	Required	—
original_name	str	Optional	—

classLocationRegionSummary3 fields

Field	Type	Requirement	Description
code	str	Required	—
name	str	Required	—
original_name	str	Optional	—

classLogRecord22 fields

Field	Type	Requirement	Description
id	int	Required	—
server_ip	None | str	Required	—
user_ip	None | str	Required	—
protocol	str	Required	—
method	str	Required	—
user_id	str	Required	—
reseller_id	str	Required	—
username	str	Required	—
hostname	str	Required	—
status_code	int	Required	—
error_code	int	Required	—
error_message	str	Required	—
country	str	Required	—
region	str	Required	—
city	str	Required	—
asn	str	Required	—
level	str	Required	—
is_session	bool	Required	—
timestamp	datetime.datetime	Required	—
package_id	str	Optional	—
package_alias	str	Optional	—
ledger_id	str	Optional	—

classLoginRequest3 fields

Field	Type	Requirement	Description
password	str	Required	Current account password.
email	str	Optional	Account email. Send either email or username.
username	str	Optional	Account username. Send either username or email.

classLogsResponse7 fields

Field	Type	Requirement	Description
count	int	Required	—
next_	None | str	Required	—
previous	None | str	Required	—
timezone	str	Required	—
start	datetime.datetime	Required	—
end	datetime.datetime	Required	—
results	list[LogRecord]	Required	—

M

classMessageResponse1 fields

Field	Type	Requirement	Description
detail	str	Required	—

N

classNews4 fields

Field	Type	Requirement	Description
title	str	Required	—
content	str	Required	The content of the news item. HTML is allowed.
id	str	Optional	—
date	datetime.datetime	Optional	The date and time when the news item is published.

O

classOTPChallenge3 fields

Field	Type	Requirement	Description
status	str	Required	—
challenge	str	Required	—
expires_in	int	Required	—

classOrder17 fields

Field	Type	Requirement	Description
is_auto_renewal	bool	Required	—
package	PackageShort	Required	—
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.
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.

classOrderDetailed18 fields

Field	Type	Requirement	Description
package	PackageShort	Required	—
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.
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.

enumOrdersListPackageType0 fields

No configurable fields.

classOverallPoint3 fields

Field	Type	Requirement	Description
data	int	Required	—
requests	int	Required	—
timestamp	datetime.datetime	Required	—

classOverallResponse7 fields

Field	Type	Requirement	Description
count	int	Required	—
next_	None | str	Required	—
previous	None | str	Required	—
timezone	str	Required	—
start	datetime.datetime	Required	—
end	datetime.datetime	Required	—
results	list[OverallPoint]	Required	—

P

classPackage19 fields

Field	Type	Requirement	Description
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
features	list[Any]	Required	—
billing_cycle	int	Required	Number of days before purchased data expires. Set to -1 for data that never expires. 30 monthly -1 never expires
billing_model	PackageBillingModel	Required	—
targeting_options	TargetingOptions	Required	—
id	str	Optional	—
type_	ProxyTypeEnum	Optional	* `static` - Static * `residential` - Residential
order	int	Optional	Display order in the UI. Lower values appear first.
is_continent_targeting	bool	Optional	When enabled, users on this package can target proxies by continent. If disabled, they will only be able to target by country or city.
is_country_targeting	bool	Optional	Allow users to target a specific country in their proxy username. country-us country-de
is_region_targeting	bool	Optional	Allow users to target a specific region in their proxy username. Requires country targeting to be enabled. country-us-region-california
is_city_targeting	bool	Optional	Allow users to target a specific city in their proxy username. Requires country and region targeting to be enabled. country-us-region-california-city-los_angeles
is_asn_targeting	bool	Optional	Allow users to target a specific ASN in their proxy username. ASNs must be configured in the provider's location vocabulary. country-us-asn-3602
description	str	Optional	Customer-facing description shown on the package listing page.
pricing	PricingEnum	Optional	* `fixed` - Fixed * `range` - Range
pricing_unit	PricingUnitEnum	Optional	* `data` - Data * `proxy` - Proxy
commission_rate	str	Optional	Reseller commission rate as a percentage of the sale price. Applies to all purchases of this package. 10.00 → 10 percent commission on every purchase
commission_type	CommissionTypeEnum	Optional	* `flexible` - Flexible * `percentage` - Percentage * `fixed` - Fixed

mapPackageBillingModel1 fields

Field	Type	Requirement	Description
[key: str]	Any	Optional	Arbitrary additional property.

classPackageCommission8 fields

Field	Type	Requirement	Description
id	UUID	Required	—
name	str	Required	—
pricing	Any	Required	—
commission_rate	float	Required	—
total_earnings	float	Required	—
total_orders	int	Required	—
pending	float	Required	—
billing_model	Any	Required	—

classPackageShort5 fields

Field	Type	Requirement	Description
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	—
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.

enumPackagesCommissionsListPricingUnit0 fields

No configurable fields.

enumPackagesCommissionsListType0 fields

No configurable fields.

enumPackagesListPricingUnit0 fields

No configurable fields.

enumPackagesListType0 fields

No configurable fields.

classPaginatedAPIKeyList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[APIKeyList]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedAffiliateList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[Affiliate]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedAffiliateRewardList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[AffiliateReward]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedCityList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[City]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedContinentList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[Continent]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedCountryList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[Country]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedCouponRedeemList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[CouponRedeem]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedCouponShortList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[CouponShort]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedISPList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[ISP]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedInvoiceReadList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[Invoice | InvoiceShort]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedLocationASNRecordList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[LocationASNRecord]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedNewsList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[News]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedOrderList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[Order]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedPackageCommissionList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[PackageCommission]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedPackageList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[Package]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedProviderDataBalanceList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[ProviderDataBalance]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedRegionList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[Region]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedRewardList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[Reward]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedUserList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[User]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPaginatedWebhookList4 fields

Field	Type	Requirement	Description
count	int	Required	—
results	list[WebhookList]	Required	—
next_	None | str	Optional	—
previous	None | str	Optional	—

classPasswordRecoveryResponse2 fields

Field	Type	Requirement	Description
message	str	Required	—
email	str	Required	—

classPatchedCouponUpdateRequest9 fields

Field	Type	Requirement	Description
value	int	Optional	Arbitrary coupon value
code	str	Optional	Coupon code cannot be changed if already set
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.
marketer	None | UUID	Optional	The marketer who owns this coupon. Required if is_marketer is true.
type_	CouponTypeEnum	Optional	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
limit	int	Optional	Number of times coupon can be used
valid_until	datetime.datetime | None	Optional	Leave empty for coupons that never expire
packages	list[str]	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

classPatchedOrderAutoRenewalRequest2 fields

Field	Type	Requirement	Description
auto_renewal_percentage	int	Optional	—
auto_renewal_data	int	Optional	—

classPatchedProfileUpdateRequest18 fields

for updating user profile information with comprehensive validation. Handles personal profile data, company information, security settings, and password changes. All fields are optional, but at least one field must be provided for the update to be valid. Includes validation for domain patterns with support for wildcards (*.example.com) and subdomains.

Field	Type	Requirement	Description
email	str	Optional	—
first_name	str	Optional	—
last_name	str	Optional	—
country	str	Optional	—
state	str	Optional	—
city	str	Optional	—
address	str	Optional	—
zip_	str	Optional	—
company_name	str	Optional	—
company_country	str	Optional	—
company_city	str	Optional	—
company_address	str	Optional	—
company_postal_code	str	Optional	—
company_vat_number	str	Optional	—
blocked_domains	list[str]	Optional	—
allowed_ips	list[str]	Optional	—
new_password	str	Optional	—
old_password	str	Optional	—

classPatchedTelegramConnectionUpdateRequest2 fields

Field	Type	Requirement	Description
locale	str	Optional	—
timezone	str	Optional	—

classPatchedUserUpdateRequest20 fields

Optional fields accepted when updating part of an existing customer account.

Field	Type	Requirement	Description
email	str	Optional	User's email address. Must be unique across the system.
first_name	str	Optional	User's first name.
last_name	str	Optional	User's last name.
country	str	Optional	User's country of residence.
state	str	Optional	User's state or province.
city	str	Optional	User's city.
address	str	Optional	User's street address.
zip_	str	Optional	User's postal/ZIP code.
company_name	str	Optional	Name of the user's company.
company_country	str	Optional	Country where the company is located.
company_city	str	Optional	City where the company is located.
company_address	str	Optional	Company's street address.
company_postal_code	str	Optional	Company's postal code.
company_vat_number	str	Optional	Company's VAT number.
is_reseller	bool	Optional	Whether the user has reseller privileges. Only superusers can modify.
blocked_domains	list[str]	Optional	List of domains to block for this user.
allowed_ips	list[str]	Optional	List of source IP addresses allowed for this user. The maximum list size is configured per deployment.
connection_limit	int	Optional	Maximum number of concurrent connections allowed for the user.
new_password	str	Optional	New password for the user. Must be 8-128 characters long.
meta	PatchedUserUpdateRequestMeta	Optional	Additional metadata for the user. Maximum 50 fields.

mapPatchedUserUpdateRequestMeta1 fields

Additional metadata for the user. Maximum 50 fields.

Field	Type	Requirement	Description
[key: str]	Any	Optional	Arbitrary additional property.

classPaymentGateway6 fields

Field	Type	Requirement	Description
code	str	Required	—
name	str	Required	—
kind	str	Required	—
supported_currencies	list[str]	Required	—
supported_crypto_currencies	list[str]	Required	—
requires_crypto_currency	bool	Required	—

classPaymentLinkResponse1 fields

Field	Type	Requirement	Description
payment_url	str	Required	Hosted checkout URL for the pending invoice.

enumPricingEnum0 fields

No configurable fields.

enumPricingUnitEnum0 fields

No configurable fields.

enumProtocolEnum0 fields

No configurable fields.

classProviderBalanceCheckpoint5 fields

Field	Type	Requirement	Description
id	UUID	Required	—
available_bytes	str	Required	Observed balance in bytes, as a decimal string.
observed_at	datetime.datetime	Required	—
created	datetime.datetime	Required	—
created_by	None | str	Required	—

classProviderDataBalance13 fields

Field	Type	Requirement	Description
checkpoint_id	UUID	Required	—
provider_id	str	Required	—
provider_name	str	Required	—
observed_at	datetime.datetime	Required	Time the available balance was observed.
available_bytes	str	Required	Observed balance in bytes, as a decimal string.
used_bytes	None | str	Required	Calculated usage since the observation, in bytes.
remaining_bytes	None | str	Required	Remaining bytes at calculated_at, as a decimal string.
remaining_percent	float | None	Required	—
severity	None | SeverityEnum	Required	—
freshness	FreshnessEnum	Required	* `fresh` - fresh * `stale` - stale * `unavailable` - unavailable
error	str	Required	—
calculated_at	datetime.datetime | None	Required	Time of the last successful calculation.
history	list[ProviderBalanceCheckpoint]	Required	Latest entries by creation time, limited by PROVIDER_DATA_BALANCE_HISTORY_LIMIT (default 10).

classProxyGenerationConnectionRequest4 fields

Field	Type	Requirement	Description
protocol	ProtocolEnum	Optional	* `http` - http * `socks5` - socks5 * `auto` - auto
host	str	Optional	Gateway host. Leave empty to choose one available gateway for the entire request.
port	int	Optional	Gateway port. Leave empty to use the port for the selected protocol.
format_	str	Optional	Connection string format.

classProxyGenerationSessionRequest1 fields

Field	Type	Requirement	Description
ttl	int	Optional	Sticky session lifetime in seconds. The accepted range is configured per deployment.

classProxyGenerationTargetingRequest8 fields

Field	Type	Requirement	Description
continent	str	Optional	Target continent code.
country	str	Optional	Target country code.
region	str	Optional	Target region or state code.
city	str	Optional	Target city code.
pool	str	Optional	Proxy pool identifier.
asn	int	Optional	Target autonomous system number.
isp	str	Optional	Target internet service provider.
os	str	Optional	Target operating system: linux, windows, ios, macos, android. Use comma-separated values only when combined OS targeting is enabled.

classProxyPasswordResetResponse2 fields

Field	Type	Requirement	Description
message	str	Required	—
success	bool	Required	—

enumProxyTypeEnum0 fields

No configurable fields.

R

classRecoverPasswordRequest2 fields

Password recovery with enhanced security and comprehensive error handling.

Field	Type	Requirement	Description
email	str	Required	Email address for password recovery
token	str	Required	Cloudflare Turnstile security token

classRegion8 fields

Field	Type	Requirement	Description
code	str	Required	Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france
name	str	Required	English display name of the region used across the admin and API responses.
country	LocationCountrySummary	Required	—
isps	list[LocationCodeName]	Required	—
asns	list[LocationCodeName]	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.
id	str	Optional	—
iso31662	str	Optional	ISO 3166-2 subdivision code for this region. US-CA FR-IDF
original_name	str	Optional	Native-language name of the region as it appears in the source data.

classResetDataRequest1 fields

Field	Type	Requirement	Description
package_id	UUID	Required	Package whose remaining data is reset to zero.

classResetPasswordRequest1 fields

Field	Type	Requirement	Description
order_id	UUID	Required	—

classReward8 fields

Field	Type	Requirement	Description
email	str	Required	—
created	datetime.datetime	Required	—
id	str	Optional	—
balance	int	Optional	—
data	int	Optional	The amount of data in bytes.
status	RewardStatusEnum	Optional	* `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled
description	str	Optional	Description of the reward, used to include payout details.
level	LevelEnum	Optional	* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond

classRewardClaimRequest2 fields

Field	Type	Requirement	Description
type_	str	Required	Reward balance to claim, for example balance or data.
description	str	Optional	Optional note stored with the claim.

enumRewardStatusEnum0 fields

No configurable fields.

enumRewardsListLevel0 fields

No configurable fields.

S

classSettingsCrypto1 fields

Field	Type	Requirement	Description
currencies	list[str]	Required	—

classSettingsGateway9 fields

Field	Type	Requirement	Description
id	UUID	Required	—
name	str	Required	—
region	str	Required	—
hostname	str	Required	Cluster gateway domain, or a server IP when no domain is configured.
hostnames	list[str]	Required	The cluster domain, or unique server IPs when no domain is configured.
port_http	int	Required	—
port_socks5	int	Required	—
port_auto	int	Required	—
port_haproxy	int	Required	—

classSettingsReferral4 fields

Field	Type	Requirement	Description
reward_balance_percentage	float	Required	—
reward_data_percentage	float	Required	—
reward_min_balance	float	Required	—
reward_min_data	float	Required	—

classSettingsResponse10 fields

Field	Type	Requirement	Description
gateways	list[SettingsGateway]	Required	—
spent_total	float	Required	—
orders_total	int	Required	—
orders_active	int	Required	—
data_available	int	Required	—
data_spent	int	Required	—
referrals	SettingsReferral	Required	—
crypto	SettingsCrypto	Required	—
payment_methods	list[str]	Required	—
payment_gateways	list[PaymentGateway]	Required	—

enumSeverityEnum0 fields

No configurable fields.

classSignUpRequest5 fields

Comprehensive user registration with enhanced validation, security measures, and referral/affiliate code handling.

Field	Type	Requirement	Description
email	str	Required	Valid email address for account creation
password	str	Required	Strong password meeting security requirements
token	str	Required	Cloudflare Turnstile security token
affiliate_code	str	Optional	Optional affiliate referral code
referral_code	str	Optional	Optional user referral code

classSubtractDataRequest2 fields

Field	Type	Requirement	Description
package_id	UUID	Required	Package of the managed virtual child order.
data	int	Required	Positive integer bytes to remove from assigned quota, not from usage. Cannot exceed total assigned data. Does not credit the parent's pool.

T

classTargetingOptions25 fields

Field	Type	Requirement	Description
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	—

classTelegramConnectionResponse8 fields

Field	Type	Requirement	Description
available	bool	Required	—
status	str	Required	—
bot_username	str	Required	—
locale	str	Required	—
timezone	str	Required	—
telegram_username	str	Optional	—
linked_at	datetime.datetime | None	Optional	—
pending_expires_at	datetime.datetime | None	Optional	—

classTelegramLinkResponse3 fields

Field	Type	Requirement	Description
status	str	Required	—
bot_url	str	Required	—
expires_at	datetime.datetime	Required	—

classTokenPairResponse2 fields

Field	Type	Requirement	Description
token	str	Required	Short-lived access token used in the Authorization header.
refresh	str	Required	Long-lived token used to request a new access token.

classTokenRefreshRequest1 fields

Field	Type	Requirement	Description
refresh	str	Required	A valid refresh token.

classTokenRefreshResponse1 fields

Field	Type	Requirement	Description
access	str	Required	New access token for the same account session.

classTransactionRecord8 fields

Field	Type	Requirement	Description
sender_uuid	None | str	Required	—
recipient_uuid	None | str	Required	—
type_	int	Required	—
amount	int	Required	—
package_uuid	None | str	Required	—
details	None | str	Required	—
date	datetime.datetime | None	Required	—
timestamp	datetime.datetime | None	Required	—

classTransactionsResponse7 fields

Field	Type	Requirement	Description
count	int	Required	—
next_	None | str	Required	—
previous	None | str	Required	—
timezone	str	Required	—
start	datetime.datetime	Required	—
end	datetime.datetime	Required	—
results	list[TransactionRecord]	Required	—

classTwoFactorConfirmRequest1 fields

Field	Type	Requirement	Description
code	str	Required	—

classTwoFactorDisableRequest3 fields

Field	Type	Requirement	Description
code	str	Required	—
password	str	Optional	—
credential	str	Optional	—

classTwoFactorSetupRequestRequest3 fields

Field	Type	Requirement	Description
password	str	Optional	—
credential	str	Optional	—
code	str	Optional	—

classTwoFactorSetupResponse3 fields

Field	Type	Requirement	Description
secret	str	Required	—
otpauth_url	str	Required	—
qr_png_base64	str	Optional	—

U

classUser43 fields

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

Field	Type	Requirement	Description
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	—
coupons	list[CouponShort]	Required	Available coupons for this user
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
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.

classUserCreateRequest18 fields

Fields accepted when a reseller or administrator creates a customer account.

Field	Type	Requirement	Description
username	str	Required	Unique username for the account. Must be 4-128 characters.
password	str	Required	Account password. Must be 8-128 characters long.
email	str	Optional	User's email address. Must be unique if provided.
first_name	str	Optional	User's first name.
last_name	str	Optional	User's last name.
country	str	Optional	User's country of residence.
state	str	Optional	User's state or province.
city	str	Optional	User's city.
address	str	Optional	User's street address.
zip_	str	Optional	User's postal/ZIP code.
blocked_domains	list[str]	Optional	List of domains to block for this user.
allowed_ips	list[str]	Optional	List of source IP addresses allowed for this user. The maximum list size is configured per deployment.
connection_limit	int	Optional	Maximum number of concurrent connections allowed for the user.
is_reseller	bool	Optional	Whether the user should have reseller privileges. Only superusers can create resellers.
is_top_level	bool	Optional	Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.
data	int	Optional	Initial integer-byte data amount. With package_id, a normal sub-user receives a virtual quota from the caller's existing root order; is_top_level=true provisions a separate paid purchase. Omit both data and package_id to create identity without package access.
package_id	UUID	Optional	ProxyRequest package UUID to assign to the user. Headless integrations resolve it from their local product mapping.
meta	UserCreateRequestMeta	Optional	Additional metadata for the user. Maximum 50 fields.

mapUserCreateRequestMeta1 fields

Additional metadata for the user. Maximum 50 fields.

Field	Type	Requirement	Description
[key: str]	Any	Optional	Arbitrary additional property.

classUserCurrency2 fields

Field	Type	Requirement	Description
code	str	Required	—
symbol	str	Required	—

classUserPasswordResetRequest1 fields

Field	Type	Requirement	Description
package_id	UUID	Optional	Package whose order's proxy password should be rotated.

V

classVerifyOTPRequest2 fields

Field	Type	Requirement	Description
challenge	str	Required	—
code	str	Required	—

W

classWebhookCreateRequest6 fields

Field	Type	Requirement	Description
type_	WebhookScopeEnum	Required	* `user` - User * `reseller` - Reseller * `system` - System
endpoint	str	Required	—
read_timeout	int	Optional	—
write_timeout	int	Optional	—
retries	int	Optional	—
retry_timeout	int	Optional	—

classWebhookCreated9 fields

Field	Type	Requirement	Description
endpoint	str	Required	HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.
created	datetime.datetime	Required	—
id	str	Optional	—
type_	WebhookScopeEnum	Optional	* `user` - User * `reseller` - Reseller * `system` - System
secret	str	Optional	Secret used to sign each webhook payload. The receiving endpoint should verify the signature to confirm the request originated from this platform. Auto-generated if left blank. Store this value securely on the receiving end.
read_timeout	int	Optional	Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.
write_timeout	int	Optional	Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.
retries	int	Optional	Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts
retry_timeout	int	Optional	How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

classWebhookList8 fields

Field	Type	Requirement	Description
endpoint	str	Required	HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout.
created	datetime.datetime	Required	—
id	str	Optional	—
type_	WebhookScopeEnum	Optional	* `user` - User * `reseller` - Reseller * `system` - System
read_timeout	int	Optional	Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.
write_timeout	int	Optional	Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.
retries	int	Optional	Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts
retry_timeout	int	Optional	How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds

enumWebhookScopeEnum0 fields

No configurable fields.

Filter 144 models

A

classAPIKeyCreate5 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
title	string	Required	| [readonly]
key	string	Required	| [readonly]
allowedIps	array<string>	Required	| [optional]
created	DateTime	Required	| [readonly]

classAPIKeyCreateRequest2 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
allowedIps	array<string>	Required	| [optional]

classAPIKeyList7 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
title	string	Required	Descriptive label that identifies the purpose or owner of this API key. Mobile App Dashboard Integration CI Pipeline |
prefix	string	Required	| [readonly]
key	string	Optional	The API key value used for authentication. Leave blank to have it generated automatically on save. Store this value securely.
allowedIps	array<string>	Required	| [readonly]
created	DateTime	Required	| [readonly]
updated	DateTime	Required	| [readonly]

classAddDataRequest2 fields

Field	Type	Requirement	Description
packageId	string	Required	Package for which the caller owns a root order. |
data	int	Required	Positive integer bytes to add to the child's assigned quota. Does not reserve parent data; may exceed the parent's remaining pool. |

classAffiliate5 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
email	string	Required	| [readonly]
signupIp	string	Optional	IP address from which the user signed up. This field is optional and can be used for tracking purposes.
signupCountry	string	Optional	Country from which the user signed up. This field is optional and can be used for tracking purposes.
dateJoined	DateTime	Required	| [optional]

classAffiliateReward8 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
email	string	Required	| [readonly]
status	RewardStatusEnum	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled
package	PackageShort	Required	| [readonly]
priceTotal	int	Required	| [readonly]
data	int	Optional	The amount of data in bytes.
commissionAmount	int	Required	| [readonly]
created	DateTime	Required	| [readonly]

classAffiliateStatsPoint4 fields

Field	Type	Requirement	Description
date	DateTime	Required	| [optional]
balance	float	Required	| [optional]
data	int	Required	| [optional]
count	int	Required	| [optional]

classAffiliateStatsResponse1 fields

Field	Type	Requirement	Description
results	[AffiliateStatsPoint[]](AffiliateStatsPoint.md)	Required	|

classAffiliatesList401Response2 fields

Field	Type	Requirement	Description
detail	string	Required	| [optional]
nonFieldErrors	array<string>	Required	| [optional]

classAffiliatesList401ResponseValue0 fields

No configurable fields.

C

classChangePasswordRequest3 fields

Field	Type	Requirement	Description
oldPassword	string	Required	|
newPassword1	string	Required	|
newPassword2	string	Required	|

enumCheckoutStatusEnum0 fields

* `not_required` - Not required * `initializing` - Initializing * `ready` - Ready * `failed` - Failed

No configurable fields.

classCity7 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
code	string	Required	Raw city code as it appears in the source data. los_angeles paris |
name	string	Required	English display name of the city used across the admin and API responses. |
country	LocationCountrySummary	Required	| [readonly]
region	LocationRegionSummary	Required	| [readonly]
isps	[LocationCodeName[]](LocationCodeName.md)	Required	| [readonly]
asns	[LocationCodeName[]](LocationCodeName.md)	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

enumCommissionTypeEnum0 fields

* `flexible` - Flexible * `percentage` - Percentage * `fixed` - Fixed

No configurable fields.

classConnectionRecord4 fields

Field	Type	Requirement	Description
userId	string	Required	|
packageId	string	Required	|
connections	int	Required	|
serverIp	string	Required	|

classConnectionsResponse4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	|
previous	string	Required	|
results	[ConnectionRecord[]](ConnectionRecord.md)	Required	|

classContinent3 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
code	string	Required	Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |
name	string	Required	English display name of the country used across the admin and API responses. |

classCountry6 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
code	string	Required	Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |
name	string	Required	English display name of the country used across the admin and API responses. |
originalName	string	Optional	Native-language name of the country as it appears in the source data. Deutschland Français
isps	[LocationCodeName[]](LocationCodeName.md)	Required	| [readonly]
asns	[LocationCodeName[]](LocationCodeName.md)	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classCoupon16 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
redeemedCount	int	Required	| [readonly]
isExpired	bool	Required	| [readonly]
isRedeemed	bool	Required	| [readonly]
packages	[PackageShort[]](PackageShort.md)	Required	| [readonly]
stats	CouponStats	Required	| [readonly]
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	|
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.

classCouponCalculatePriceRequest3 fields

Field	Type	Requirement	Description
packageId	string	Required	| [optional]
couponCode	string	Required	|
data	int	Required	|

classCouponCreateRequest9 fields

Field	Type	Requirement	Description
value	int	Required	Arbitrary coupon value |
code	string	Optional	Leave empty to auto-generate a 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.
marketer	string	Optional	The marketer who owns this coupon. Required if is_marketer is true.
type	CouponTypeEnum	Required	|
limit	int	Optional	Number of times coupon can be used
validUntil	DateTime	Optional	Leave empty for coupons that never expire
packages	array<string>	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

classCouponPriceResponse3 fields

Field	Type	Requirement	Description
priceOriginal	int	Required	Original price in the service's smallest currency unit. |
priceDiscounted	int	Required	Price after applying the coupon, in the smallest currency unit. |
discountPercentage	float	Required	|

classCouponRedeem7 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
user	string	Required	|
invoice	string	Required	| [optional]
invoiceAmount	float	Required	| [readonly]
discountApplied	float	Required	| [readonly]
redeemedAt	DateTime	Required	| [optional]
created	DateTime	Required	| [readonly]

classCouponShort14 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
isExpired	bool	Required	| [readonly]
isRedeemed	bool	Required	| [readonly]
packages	[PackageShort[]](PackageShort.md)	Required	| [readonly]
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	|
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.

classCouponStats5 fields

Field	Type	Requirement	Description
totalRedeems	int	Required	|
uniqueUsers	int	Required	|
totalRevenue	int	Required	|
totalDiscountGiven	int	Required	|
totalDataGiven	int	Required	|

enumCouponTypeEnum0 fields

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

No configurable fields.

classCouponUpdateRequest9 fields

Field	Type	Requirement	Description
value	int	Required	Arbitrary coupon value |
code	string	Optional	Coupon code cannot be changed if already set
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.
marketer	string	Optional	The marketer who owns this coupon. Required if is_marketer is true.
type	CouponTypeEnum	Required	|
limit	int	Optional	Number of times coupon can be used
validUntil	DateTime	Optional	Leave empty for coupons that never expire
packages	array<string>	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

D

classDataLedger6 fields

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.

Field	Type	Requirement	Description
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]

classDomainRecord3 fields

Field	Type	Requirement	Description
hostname	string	Required	|
requests	int	Required	|
data	int	Required	|

classDomainsResponse6 fields

Field	Type	Requirement	Description
next	string	Required	|
previous	string	Required	|
timezone	string	Required	|
start	DateTime	Required	|
end	DateTime	Required	|
results	[DomainRecord[]](DomainRecord.md)	Required	|

E

classEnabledResponse1 fields

Field	Type	Requirement	Description
enabled	bool	Required	|

F

classFeedRecord20 fields

Field	Type	Requirement	Description
id	string	Required	Exact decimal UInt64 identifier, normalized from the API JSON number. |
establishedConnections	int	Required	|
resellerId	string	Required	|
userId	string	Required	|
packageId	string	Required	|
ledgerId	string	Required	|
username	string	Required	|
userIp	string	Required	|
serverIp	string	Required	|
data	int	Required	|
hostname	string	Required	|
protocol	string	Required	|
method	string	Required	|
pool	string	Required	|
isSession	bool	Required	|
country	string	Required	|
region	string	Required	|
city	string	Required	|
asn	string	Required	|
timestamp	DateTime	Required	|

classFeedResponse7 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	|
previous	string	Required	|
timezone	string	Required	|
start	DateTime	Required	|
end	DateTime	Required	|
results	[FeedRecord[]](FeedRecord.md)	Required	|

enumFreshnessEnum0 fields

* `fresh` - fresh * `stale` - stale * `unavailable` - unavailable

No configurable fields.

G

classGenerateProxyRequest6 fields

Validates proxy generation request data and builds generator config.

Field	Type	Requirement	Description
packageId	string	Required	ProxyRequest package UUID used to generate credentials. Headless integrations must resolve this from their local product mapping. |
userId	string	Optional	ProxyRequest sub-user UUID that will use the generated credentials. Resolve it from your local customer mapping. Must be the caller's own sub-user, even for superusers. Omit to generate for the authenticated account. For an independent top-level customer, authenticate as that customer rather than sending its ID with a global key.
quantity	int	Required	Number of proxies to generate |
targeting	ProxyGenerationTargetingRequest	Required	| [optional]
connection	ProxyGenerationConnectionRequest	Required	| [optional]
session	ProxyGenerationSessionRequest	Required	| [optional]

classGenerateProxyResponse2 fields

Field	Type	Requirement	Description
count	int	Required	|
proxies	[GeneratedProxy[]](GeneratedProxy.md)	Required	|

classGeneratedProxy6 fields

Field	Type	Requirement	Description
host	string	Required	|
port	int	Required	|
protocol	string	Required	|
username	string	Required	|
password	string	Required	|
connectionString	string	Required	|

classGoogleAuthRequest5 fields

Enhanced Google OAuth authentication with comprehensive security validation and user management.

Field	Type	Requirement	Description
credential	string	Required	Google ID token credential |
clientId	string	Optional	Google OAuth client ID
selectBy	string	Optional	User selection method
affiliateCode	string	Optional	Optional affiliate code
referralCode	string	Optional	Optional referral code

I

classISP2 fields

Field	Type	Requirement	Description
code	string	Required	Unique internal code used to identify this ISP in location vocabulary entries and provider routing rules. comcast att deutsche_telekom |
name	string	Required	Full display name of the Internet Service Provider. Comcast Cable Communications AT&T Services |

classInvoice38 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
package	PackageShort	Required	| [readonly]
country	Country	Required	| [readonly]
userId	string	Required	| [readonly]
coupon	CouponShort	Required	| [readonly]
paymentAmount	int	Required	| [readonly]
paymentCurrency	string	Required	| [readonly]
fxMarketRate	string	Required	| [readonly]
fxEffectiveRate	string	Required	| [readonly]
fxMarkupPercent	string	Required	| [readonly]
fxQuotedAt	DateTime	Required	| [readonly]
updated	DateTime	Required	| [readonly]
created	DateTime	Required	| [readonly]
type	InvoiceTypeEnum	Optional	The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance
isOneTime	bool	Optional	Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.
isPayout	bool	Optional	Indicates whether this invoice is a payout to the marketer. Default is False.
internalId	string	Optional	A unique identifier for the invoice, generated automatically.
status	InvoiceStatusEnum	Optional	Payment state. A paid package invoice funds an order; a paid balance invoice credits money. Confirm the resulting order before delivering access, because fulfillment can recover asynchronously. Creating an invoice with status=paid requires a superuser. This read field is not a public status-update or refund endpoint. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
description	string	Optional	A description of the invoice. This field is optional and can be left blank.
connectionLimit	int	Optional	The maximum number of concurrent connections allowed for this package.
quantity	int	Optional	The number of proxies to assign.
data	int	Optional	The amount of data in bytes.
balance	int	Optional	The balance to top up for the user. Must be zero or positive.
priceTotal	int	Optional	The total price of the invoice, including any discounts. Must be at least 1 cent.
gateway	InvoiceGatewayEnum	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
paymentUrl	string	Optional	The URL for making the payment. Optional field with a maximum length of 500 characters.
currency	string	Optional	ISO 4217 currency captured when the invoice is created.
providerCheckoutId	string	Optional	Provider-side hosted checkout identifier used for reconciliation.
providerPaymentId	string	Optional	Provider-side payment or transaction identifier used for reconciliation.
checkoutStatus	CheckoutStatusEnum	Required	| [optional]
vat	float	Optional	The VAT percentage applied to the invoice. Must be between 0 and 100.
companyName	string	Required	| [optional]
companyAddress	string	Required	| [optional]
companyCity	string	Required	| [optional]
companyPostalCode	string	Required	| [optional]
companyRegistrationNumber	string	Required	| [optional]
companyVatNumber	string	Required	| [optional]
paid	DateTime	Optional	The date and time when the invoice was paid.

classInvoiceCreateRequest16 fields

Field	Type	Requirement	Description
packageId	string	Optional	Package to purchase. Required for package purchases.
userId	string	Optional	Account receiving the purchase. Omit for your own account. Sending user_id requires is_reseller; a reseller can target its own sub-user, while a superuser with is_reseller can target another account. Do not send your own ID.
gateway	InvoiceCreateRequestGatewayEnum	Required	|
status	InvoiceCreateRequestStatusEnum	Optional	Initial invoice status. Defaults to pending. Setting paid requires a superuser or an active superuser's API key, including requests using X-Impersonate-User. Other authenticated users receive a 403 response. * `pending` - pending * `paid` - paid
cryptoCurrency	string	Required	| [optional]
paymentCurrency	string	Optional	ISO 4217 currency charged by a regional fiat provider.
couponCode	string	Required	| [optional]
countryCode	string	Required	| [optional]
data	int	Optional	Residential proxy data to purchase, in integer bytes (1 GiB = 1073741824). Required with package_id for a residential purchase. A paid purchase funds the recipient's order; it is not a virtual allocation from a parent pool.
quantity	int	Optional	Number of static proxies to purchase.
amount	int	Optional	Account balance amount to purchase, in the smallest currency unit. Use for a wallet top-up without package_id, not for buying proxy data.
connectionLimit	int	Required	| [optional]
expires	int	Optional	Optional future expiration as a Unix timestamp in seconds, not milliseconds. Otherwise a positive package billing cycle determines the purchased data's expiration from the payment date; a zero cycle has no automatic expiration. A later purchase does not extend earlier finite, expiring ledgers.
companyName	string	Required	| [optional]
companyRegistrationNumber	string	Required	| [optional]
companyVatNumber	string	Required	| [optional]

enumInvoiceCreateRequestGatewayEnum0 fields

* `crypto` - crypto * `credit_card` - credit_card * `wallet` - wallet * `manual` - manual * `stripe` - stripe * `coinbase` - coinbase * `cryptomus` - cryptomus * `coingate` - coingate * `whitepay` - whitepay * `wayforpay` - wayforpay * `usegateway` - usegateway * `binance` - binance * `anymoney` - anymoney * `coinpayments` - coinpayments * `checkoutcom` - checkoutcom * `nowpayments` - nowpayments * `btcpay` - btcpay * `braintree` - braintree * `monobank` - monobank * `liqpay` - liqpay * `iyzico` - iyzico * `paytr` - paytr * `payu` - payu * `tpay` - tpay * `przelewy24` - przelewy24 * `gopay` - gopay * `comgate` - comgate * `monei` - monei * `redsys` - redsys * `payplug` - payplug * `mollie` - mollie * `unzer` - unzer * `payone` - payone * `nexi_xpay` - nexi_xpay * `halyk_epay` - halyk_epay * `kaspi_pay` - kaspi_pay * `vipps_mobilepay` - vipps_mobilepay * `paytrail` - paytrail

No configurable fields.

enumInvoiceCreateRequestStatusEnum0 fields

* `pending` - pending * `paid` - paid

No configurable fields.

enumInvoiceGatewayEnum0 fields

* `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail

No configurable fields.

classInvoiceRead39 fields

Invoice details. Creation, list, and detail responses use the same Invoice representation.

Field	Type	Requirement	Description
id	string	Required	| [optional]
package	PackageShort	Required	| [readonly]
country	Country	Required	| [readonly]
userId	string	Required	| [readonly]
coupon	Coupon	Required	| [readonly]
paymentAmount	int	Required	| [readonly]
paymentCurrency	string	Required	| [readonly]
fxMarketRate	string	Required	| [readonly]
fxEffectiveRate	string	Required	| [readonly]
fxMarkupPercent	string	Required	| [readonly]
fxQuotedAt	DateTime	Required	| [readonly]
updated	DateTime	Required	| [readonly]
created	DateTime	Required	| [readonly]
type	InvoiceTypeEnum	Optional	The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance
isOneTime	bool	Optional	Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.
isPayout	bool	Optional	Indicates whether this invoice is a payout to the marketer. Default is False.
internalId	string	Optional	A unique identifier for the invoice, generated automatically.
status	InvoiceStatusEnum	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
description	string	Optional	A description of the invoice. This field is optional and can be left blank.
connectionLimit	int	Optional	The maximum number of concurrent connections allowed for this package.
quantity	int	Optional	The number of proxies to assign.
data	int	Optional	The amount of data in bytes.
balance	int	Optional	The balance to top up for the user. Must be zero or positive.
priceTotal	int	Optional	The total price of the invoice, including any discounts. Must be at least 1 cent.
gateway	InvoiceGatewayEnum	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
paymentUrl	string	Optional	The URL for making the payment. Optional field with a maximum length of 500 characters.
currency	string	Optional	ISO 4217 currency captured when the invoice is created.
providerCheckoutId	string	Optional	Provider-side hosted checkout identifier used for reconciliation.
providerPaymentId	string	Optional	Provider-side payment or transaction identifier used for reconciliation.
checkoutStatus	CheckoutStatusEnum	Required	| [optional]
vat	float	Optional	The VAT percentage applied to the invoice. Must be between 0 and 100.
companyName	string	Required	| [optional]
companyAddress	string	Required	| [optional]
companyCity	string	Required	| [optional]
companyPostalCode	string	Required	| [optional]
companyRegistrationNumber	string	Required	| [optional]
companyVatNumber	string	Required	| [optional]
paid	DateTime	Optional	The date and time when the invoice was paid.
expires	DateTime	Optional	The date and time when the invoice expires. If not set, the invoice does not expire.

classInvoiceShort28 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
coupon	Coupon	Required	| [readonly]
country	Country	Required	| [readonly]
updated	DateTime	Required	| [readonly]
created	DateTime	Required	| [readonly]
isOneTime	bool	Optional	Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.
isPayout	bool	Optional	Indicates whether this invoice is a payout to the marketer. Default is False.
internalId	string	Optional	A unique identifier for the invoice, generated automatically.
status	InvoiceStatusEnum	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
description	string	Optional	A description of the invoice. This field is optional and can be left blank.
connectionLimit	int	Optional	The maximum number of concurrent connections allowed for this package.
data	int	Optional	The amount of data in bytes.
balance	int	Optional	The balance to top up for the user. Must be zero or positive.
priceTotal	int	Optional	The total price of the invoice, including any discounts. Must be at least 1 cent.
gateway	InvoiceGatewayEnum	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
currency	string	Optional	ISO 4217 currency captured when the invoice is created.
providerCheckoutId	string	Optional	Provider-side hosted checkout identifier used for reconciliation.
providerPaymentId	string	Optional	Provider-side payment or transaction identifier used for reconciliation.
checkoutStatus	CheckoutStatusEnum	Required	| [optional]
vat	float	Optional	The VAT percentage applied to the invoice. Must be between 0 and 100.
companyName	string	Required	| [optional]
companyAddress	string	Required	| [optional]
companyCity	string	Required	| [optional]
companyPostalCode	string	Required	| [optional]
companyRegistrationNumber	string	Required	| [optional]
companyVatNumber	string	Required	| [optional]
paid	DateTime	Optional	The date and time when the invoice was paid.
expires	DateTime	Optional	The date and time when the invoice expires. If not set, the invoice does not expire.

enumInvoiceStatusEnum0 fields

* `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error

No configurable fields.

enumInvoiceTypeEnum0 fields

* `static` - Static * `residential` - Residential * `balance` - Balance

No configurable fields.

classInvoicesCreate502Response4 fields

Field	Type	Requirement	Description
invoiceId	string	Required	|
gateway	string	Required	|
retryable	bool	Required	|
nonFieldErrors	array<string>	Required	|

L

enumLanguageEnum0 fields

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

No configurable fields.

enumLevelEnum0 fields

* `standard` - Standard * `silver` - Silver * `gold` - Gold * `diamond` - Diamond

No configurable fields.

classLocationASNGeoItem3 fields

Field	Type	Requirement	Description
country	LocationCodeName	Required	|
region	LocationCodeName	Required	| [optional]
city	LocationCodeName	Required	| [optional]

classLocationASNRecord3 fields

Field	Type	Requirement	Description
code	string	Required	|
name	string	Required	|
geo	[LocationASNGeoItem[]](LocationASNGeoItem.md)	Required	| [optional]

classLocationCodeName2 fields

Field	Type	Requirement	Description
code	string	Required	|
name	string	Required	|

classLocationCountrySummary3 fields

Field	Type	Requirement	Description
code	string	Required	|
name	string	Required	|
originalName	string	Required	| [optional]

classLocationRegionSummary3 fields

Field	Type	Requirement	Description
code	string	Required	|
name	string	Required	|
originalName	string	Required	| [optional]

classLogRecord22 fields

Field	Type	Requirement	Description
id	int	Required	|
serverIp	string	Required	|
userIp	string	Required	|
protocol	string	Required	|
method	string	Required	|
userId	string	Required	|
resellerId	string	Required	|
username	string	Required	|
hostname	string	Required	|
statusCode	int	Required	|
errorCode	int	Required	|
errorMessage	string	Required	|
country	string	Required	|
region	string	Required	|
city	string	Required	|
asn	string	Required	|
level	string	Required	|
isSession	bool	Required	|
timestamp	DateTime	Required	|
packageId	string	Required	| [optional]
packageAlias	string	Required	| [optional]
ledgerId	string	Required	| [optional]

classLoginRequest3 fields

Field	Type	Requirement	Description
email	string	Optional	Account email. Send either email or username.
username	string	Optional	Account username. Send either username or email.
password	string	Required	Current account password. |

classLogsResponse7 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	|
previous	string	Required	|
timezone	string	Required	|
start	DateTime	Required	|
end	DateTime	Required	|
results	[LogRecord[]](LogRecord.md)	Required	|

M

classMessageResponse1 fields

Field	Type	Requirement	Description
detail	string	Required	|

N

classNews4 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
title	string	Required	|
content	string	Required	The content of the news item. HTML is allowed. |
date	DateTime	Optional	The date and time when the news item is published.

enumNullEnum0 fields

No configurable fields.

O

classOTPChallenge3 fields

Field	Type	Requirement	Description
status	string	Required	|
challenge	string	Required	|
expiresIn	int	Required	|

classOrder17 fields

Field	Type	Requirement	Description
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]
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.
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]

classOrderDetailed18 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
package	PackageShort	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.
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.

classOverallPoint3 fields

Field	Type	Requirement	Description
data	int	Required	|
requests	int	Required	|
timestamp	DateTime	Required	|

classOverallResponse7 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	|
previous	string	Required	|
timezone	string	Required	|
start	DateTime	Required	|
end	DateTime	Required	|
results	[OverallPoint[]](OverallPoint.md)	Required	|

P

classPackage19 fields

Field	Type	Requirement	Description
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 |
type	ProxyTypeEnum	Required	| [optional]
order	int	Optional	Display order in the UI. Lower values appear first.
isContinentTargeting	bool	Optional	When enabled, users on this package can target proxies by continent. If disabled, they will only be able to target by country or city.
isCountryTargeting	bool	Optional	Allow users to target a specific country in their proxy username. country-us country-de
isRegionTargeting	bool	Optional	Allow users to target a specific region in their proxy username. Requires country targeting to be enabled. country-us-region-california
isCityTargeting	bool	Optional	Allow users to target a specific city in their proxy username. Requires country and region targeting to be enabled. country-us-region-california-city-los_angeles
isAsnTargeting	bool	Optional	Allow users to target a specific ASN in their proxy username. ASNs must be configured in the provider's location vocabulary. country-us-asn-3602
features	array<mixed>	Required	| [readonly]
description	string	Optional	Customer-facing description shown on the package listing page.
pricing	PricingEnum	Optional	Pricing model applied when customers purchase data on this package. Fixed a fixed price per data amount — 10 GB for $10, 50 GB for $50 Range tiered pricing where the unit price decreases as quantity increases * `fixed` - Fixed * `range` - Range
pricingUnit	PricingUnitEnum	Optional	Unit customers purchase — determines how the billing model amounts are interpreted. * `data` - Data * `proxy` - Proxy
billingCycle	int	Required	Number of days before purchased data expires. Set to -1 for data that never expires. 30 monthly -1 never expires |
billingModel	array<string,mixed>	Required	| [readonly]
commissionRate	float	Optional	Reseller commission rate as a percentage of the sale price. Applies to all purchases of this package. 10.00 → 10 percent commission on every purchase
commissionType	CommissionTypeEnum	Optional	How the commission rate is applied to reseller sales. Fixed a fixed percentage regardless of sale amount Flexible rate may vary based on negotiated reseller terms * `flexible` - Flexible * `percentage` - Percentage * `fixed` - Fixed
targetingOptions	TargetingOptions	Required	| [readonly]

classPackageCommission8 fields

Field	Type	Requirement	Description
id	string	Required	|
name	string	Required	|
pricing	mixed	Required	|
commissionRate	float	Required	|
totalEarnings	float	Required	|
totalOrders	int	Required	|
pending	float	Required	|
billingModel	mixed	Required	|

classPackageShort5 fields

Field	Type	Requirement	Description
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]

classPaginatedAPIKeyList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[APIKeyList[]](APIKeyList.md)	Required	|

classPaginatedAffiliateList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[Affiliate[]](Affiliate.md)	Required	|

classPaginatedAffiliateRewardList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[AffiliateReward[]](AffiliateReward.md)	Required	|

classPaginatedCityList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[City[]](City.md)	Required	|

classPaginatedContinentList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[Continent[]](Continent.md)	Required	|

classPaginatedCountryList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[Country[]](Country.md)	Required	|

classPaginatedCouponRedeemList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[CouponRedeem[]](CouponRedeem.md)	Required	|

classPaginatedCouponShortList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[CouponShort[]](CouponShort.md)	Required	|

classPaginatedISPList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[ISP[]](ISP.md)	Required	|

classPaginatedInvoiceList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[Invoice[]](Invoice.md)	Required	|

classPaginatedInvoiceReadList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[InvoiceRead[]](InvoiceRead.md)	Required	|

classPaginatedLocationASNRecordList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[LocationASNRecord[]](LocationASNRecord.md)	Required	|

classPaginatedNewsList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[News[]](News.md)	Required	|

classPaginatedOrderList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[Order[]](Order.md)	Required	|

classPaginatedPackageCommissionList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[PackageCommission[]](PackageCommission.md)	Required	|

classPaginatedPackageList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[Package[]](Package.md)	Required	|

classPaginatedProviderDataBalanceList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[ProviderDataBalance[]](ProviderDataBalance.md)	Required	|

classPaginatedRegionList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[Region[]](Region.md)	Required	|

classPaginatedRewardList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[Reward[]](Reward.md)	Required	|

classPaginatedUserList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[User[]](User.md)	Required	|

classPaginatedWebhookList4 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	| [optional]
previous	string	Required	| [optional]
results	[WebhookList[]](WebhookList.md)	Required	|

classPasswordRecoveryResponse2 fields

Field	Type	Requirement	Description
message	string	Required	|
email	string	Required	|

classPatchedCouponUpdateRequest9 fields

Field	Type	Requirement	Description
value	int	Optional	Arbitrary coupon value
code	string	Optional	Coupon code cannot be changed if already set
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.
marketer	string	Optional	The marketer who owns this coupon. Required if is_marketer is true.
type	CouponTypeEnum	Required	| [optional]
limit	int	Optional	Number of times coupon can be used
validUntil	DateTime	Optional	Leave empty for coupons that never expire
packages	array<string>	Optional	Select packages for which this coupon is available. If no packages are selected, the coupon is available to all packages.

classPatchedOrderAutoRenewalRequest2 fields

Field	Type	Requirement	Description
autoRenewalPercentage	int	Required	| [optional]
autoRenewalData	int	Required	| [optional]

classPatchedProfileUpdateRequest18 fields

for updating user profile information with comprehensive validation. Handles personal profile data, company information, security settings, and password changes. All fields are optional, but at least one field must be provided for the update to be valid. Includes validation for domain patterns with support for wildcards (*.example.com) and subdomains.

Field	Type	Requirement	Description
email	string	Required	| [optional]
firstName	string	Required	| [optional]
lastName	string	Required	| [optional]
country	string	Required	| [optional]
state	string	Required	| [optional]
city	string	Required	| [optional]
address	string	Required	| [optional]
zip	string	Required	| [optional]
companyName	string	Required	| [optional]
companyCountry	string	Required	| [optional]
companyCity	string	Required	| [optional]
companyAddress	string	Required	| [optional]
companyPostalCode	string	Required	| [optional]
companyVatNumber	string	Required	| [optional]
blockedDomains	array<string>	Required	| [optional]
allowedIps	array<string>	Required	| [optional]
newPassword	string	Required	| [optional]
oldPassword	string	Required	| [optional]

classPatchedTelegramConnectionUpdateRequest2 fields

Field	Type	Requirement	Description
locale	string	Required	| [optional]
timezone	string	Required	| [optional]

classPatchedUserUpdateRequest20 fields

Optional fields accepted when updating part of an existing customer account.

Field	Type	Requirement	Description
email	string	Optional	User's email address. Must be unique across the system.
firstName	string	Optional	User's first name.
lastName	string	Optional	User's last name.
country	string	Optional	User's country of residence.
state	string	Optional	User's state or province.
city	string	Optional	User's city.
address	string	Optional	User's street address.
zip	string	Optional	User's postal/ZIP code.
companyName	string	Optional	Name of the user's company.
companyCountry	string	Optional	Country where the company is located.
companyCity	string	Optional	City where the company is located.
companyAddress	string	Optional	Company's street address.
companyPostalCode	string	Optional	Company's postal code.
companyVatNumber	string	Optional	Company's VAT number.
isReseller	bool	Optional	Whether the user has reseller privileges. Only superusers can modify.
blockedDomains	array<string>	Optional	List of domains to block for this user.
allowedIps	array<string>	Optional	List of source IP addresses allowed for this user. The maximum list size is configured per deployment.
connectionLimit	int	Optional	Maximum number of concurrent connections allowed for the user.
newPassword	string	Optional	New password for the user. Must be 8-128 characters long.
meta	array<string,mixed>	Optional	Additional metadata for the user. Maximum 50 fields.

classPaymentGateway6 fields

Field	Type	Requirement	Description
code	string	Required	|
name	string	Required	|
kind	string	Required	|
supportedCurrencies	array<string>	Required	|
supportedCryptoCurrencies	array<string>	Required	|
requiresCryptoCurrency	bool	Required	|

classPaymentLinkResponse1 fields

Field	Type	Requirement	Description
paymentUrl	string	Required	Hosted checkout URL for the pending invoice. |

enumPricingEnum0 fields

* `fixed` - Fixed * `range` - Range

No configurable fields.

enumPricingUnitEnum0 fields

* `data` - Data * `proxy` - Proxy

No configurable fields.

enumProtocolEnum0 fields

* `http` - http * `socks5` - socks5 * `auto` - auto

No configurable fields.

classProviderBalanceCheckpoint5 fields

Field	Type	Requirement	Description
id	string	Required	| [readonly]
availableBytes	string	Required	Observed balance in bytes, as a decimal string. |
observedAt	DateTime	Required	|
created	DateTime	Required	| [readonly]
createdBy	string	Required	| [readonly]

classProviderDataBalance13 fields

Field	Type	Requirement	Description
checkpointId	string	Required	|
providerId	string	Required	|
providerName	string	Required	|
observedAt	DateTime	Required	Time the available balance was observed. |
availableBytes	string	Required	Observed balance in bytes, as a decimal string. |
usedBytes	string	Required	Calculated usage since the observation, in bytes. |
remainingBytes	string	Required	Remaining bytes at calculated_at, as a decimal string. |
remainingPercent	float	Required	|
severity	string	Required	|
freshness	FreshnessEnum	Required	|
error	string	Required	|
calculatedAt	DateTime	Required	Time of the last successful calculation. |
history	[ProviderBalanceCheckpoint[]](ProviderBalanceCheckpoint.md)	Required	Latest entries by creation time, limited by PROVIDER_DATA_BALANCE_HISTORY_LIMIT (default 10). |

classProxyGenerationConnectionRequest4 fields

Field	Type	Requirement	Description
protocol	ProtocolEnum	Optional	Proxy protocol. * `http` - http * `socks5` - socks5 * `auto` - auto
host	string	Optional	Gateway host. Leave empty to choose one available gateway for the entire request.
port	int	Optional	Gateway port. Leave empty to use the port for the selected protocol.
format	string	Optional	Connection string format.

classProxyGenerationSessionRequest1 fields

Field	Type	Requirement	Description
ttl	int	Optional	Sticky session lifetime in seconds. The accepted range is configured per deployment.

classProxyGenerationTargetingRequest8 fields

Field	Type	Requirement	Description
continent	string	Optional	Target continent code.
country	string	Optional	Target country code.
region	string	Optional	Target region or state code.
city	string	Optional	Target city code.
pool	string	Optional	Proxy pool identifier.
asn	int	Optional	Target autonomous system number.
isp	string	Optional	Target internet service provider.
os	string	Optional	Target operating system: linux, windows, ios, macos, android. Use comma-separated values only when combined OS targeting is enabled.

classProxyPasswordResetResponse2 fields

Field	Type	Requirement	Description
message	string	Required	|
success	bool	Required	|

enumProxyTypeEnum0 fields

* `static` - Static * `residential` - Residential

No configurable fields.

R

classRecoverPasswordRequest2 fields

Password recovery with enhanced security and comprehensive error handling.

Field	Type	Requirement	Description
email	string	Required	Email address for password recovery |
token	string	Required	Cloudflare Turnstile security token |

classRegion8 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
code	string	Required	Raw region code as it appears in the source data. Used together with country to form a unique identifier. california ile_de_france |
iso31662	string	Optional	ISO 3166-2 subdivision code for this region. US-CA FR-IDF
name	string	Required	English display name of the region used across the admin and API responses. |
originalName	string	Optional	Native-language name of the region as it appears in the source data.
country	LocationCountrySummary	Required	| [readonly]
isps	[LocationCodeName[]](LocationCodeName.md)	Required	| [readonly]
asns	[LocationCodeName[]](LocationCodeName.md)	Required	The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classResetDataRequest1 fields

Field	Type	Requirement	Description
packageId	string	Required	Package whose remaining data is reset to zero. |

classResetPasswordRequest1 fields

Field	Type	Requirement	Description
orderId	string	Required	|

classReward8 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
email	string	Required	| [readonly]
created	DateTime	Required	| [readonly]
balance	int	Required	| [optional]
data	int	Optional	The amount of data in bytes.
status	RewardStatusEnum	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled
description	string	Optional	Description of the reward, used to include payout details.
level	LevelEnum	Required	| [optional]

classRewardClaimRequest2 fields

Field	Type	Requirement	Description
type	string	Required	Reward balance to claim, for example balance or data. |
description	string	Optional	Optional note stored with the claim.

enumRewardStatusEnum0 fields

* `pending` - Pending * `paid` - Paid * `review` - Review * `cancelled` - Cancelled

No configurable fields.

S

classSettingsCrypto1 fields

Field	Type	Requirement	Description
currencies	array<string>	Required	|

classSettingsGateway9 fields

Field	Type	Requirement	Description
id	string	Required	|
name	string	Required	|
region	string	Required	|
hostname	string	Required	Cluster gateway domain, or a server IP when no domain is configured. |
hostnames	array<string>	Required	The cluster domain, or unique server IPs when no domain is configured. |
portHttp	int	Required	|
portSocks5	int	Required	|
portAuto	int	Required	|
portHaproxy	int	Required	|

classSettingsReferral4 fields

Field	Type	Requirement	Description
rewardBalancePercentage	float	Required	|
rewardDataPercentage	float	Required	|
rewardMinBalance	float	Required	|
rewardMinData	float	Required	|

classSettingsResponse10 fields

Field	Type	Requirement	Description
gateways	[SettingsGateway[]](SettingsGateway.md)	Required	|
spentTotal	float	Required	|
ordersTotal	int	Required	|
ordersActive	int	Required	|
dataAvailable	int	Required	|
dataSpent	int	Required	|
referrals	SettingsReferral	Required	|
crypto	SettingsCrypto	Required	|
paymentMethods	array<string>	Required	|
paymentGateways	[PaymentGateway[]](PaymentGateway.md)	Required	|

enumSeverityEnum0 fields

* `warning` - warning * `danger` - danger

No configurable fields.

classSignUpRequest5 fields

Comprehensive user registration with enhanced validation, security measures, and referral/affiliate code handling.

Field	Type	Requirement	Description
email	string	Required	Valid email address for account creation |
password	string	Required	Strong password meeting security requirements |
token	string	Required	Cloudflare Turnstile security token |
affiliateCode	string	Optional	Optional affiliate referral code
referralCode	string	Optional	Optional user referral code

classSubtractDataRequest2 fields

Field	Type	Requirement	Description
packageId	string	Required	Package of the managed virtual child order. |
data	int	Required	Positive integer bytes to remove from assigned quota, not from usage. Cannot exceed total assigned data. Does not credit the parent's pool. |

T

classTargetingOptions25 fields

Field	Type	Requirement	Description
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	|

classTelegramConnectionResponse8 fields

Field	Type	Requirement	Description
available	bool	Required	|
status	string	Required	|
botUsername	string	Required	|
telegramUsername	string	Required	| [optional]
locale	string	Required	|
timezone	string	Required	|
linkedAt	DateTime	Required	| [optional]
pendingExpiresAt	DateTime	Required	| [optional]

classTelegramLinkResponse3 fields

Field	Type	Requirement	Description
status	string	Required	|
botUrl	string	Required	|
expiresAt	DateTime	Required	|

classTokenPairResponse2 fields

Field	Type	Requirement	Description
token	string	Required	Short-lived access token used in the Authorization header. |
refresh	string	Required	Long-lived token used to request a new access token. |

classTokenRefreshRequest1 fields

Field	Type	Requirement	Description
refresh	string	Required	A valid refresh token. |

classTokenRefreshResponse1 fields

Field	Type	Requirement	Description
access	string	Required	New access token for the same account session. |

classTransactionRecord8 fields

Field	Type	Requirement	Description
senderUuid	string	Required	|
recipientUuid	string	Required	|
type	int	Required	|
amount	int	Required	|
packageUuid	string	Required	|
details	string	Required	|
date	DateTime	Required	|
timestamp	DateTime	Required	|

classTransactionsResponse7 fields

Field	Type	Requirement	Description
count	int	Required	|
next	string	Required	|
previous	string	Required	|
timezone	string	Required	|
start	DateTime	Required	|
end	DateTime	Required	|
results	[TransactionRecord[]](TransactionRecord.md)	Required	|

classTwoFactorConfirmRequest1 fields

Field	Type	Requirement	Description
code	string	Required	|

classTwoFactorDisableRequest3 fields

Field	Type	Requirement	Description
password	string	Required	| [optional]
credential	string	Required	| [optional]
code	string	Required	|

classTwoFactorSetupRequestRequest3 fields

Field	Type	Requirement	Description
password	string	Required	| [optional]
credential	string	Required	| [optional]
code	string	Required	| [optional]

classTwoFactorSetupResponse3 fields

Field	Type	Requirement	Description
secret	string	Required	|
otpauthUrl	string	Required	|
qrPngBase64	string	Required	| [optional]

U

classUser43 fields

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

Field	Type	Requirement	Description
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]
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
coupons	[CouponShort[]](CouponShort.md)	Required	Available coupons for this user
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.

classUserCreateRequest18 fields

Fields accepted when a reseller or administrator creates a customer account.

Field	Type	Requirement	Description
email	string	Optional	User's email address. Must be unique if provided.
username	string	Required	Unique username for the account. Must be 4-128 characters. |
password	string	Required	Account password. Must be 8-128 characters long. |
firstName	string	Optional	User's first name.
lastName	string	Optional	User's last name.
country	string	Optional	User's country of residence.
state	string	Optional	User's state or province.
city	string	Optional	User's city.
address	string	Optional	User's street address.
zip	string	Optional	User's postal/ZIP code.
blockedDomains	array<string>	Optional	List of domains to block for this user.
allowedIps	array<string>	Optional	List of source IP addresses allowed for this user. The maximum list size is configured per deployment.
connectionLimit	int	Optional	Maximum number of concurrent connections allowed for the user.
isReseller	bool	Optional	Whether the user should have reseller privileges. Only superusers can create resellers.
isTopLevel	bool	Optional	Superuser only: true creates an independent account with no parent. False (default) creates a sub-user under the caller.
data	int	Optional	Initial integer-byte data amount. With package_id, a normal sub-user receives a virtual quota from the caller's existing root order; is_top_level=true provisions a separate paid purchase. Omit both data and package_id to create identity without package access.
packageId	string	Optional	ProxyRequest package UUID to assign to the user. Headless integrations resolve it from their local product mapping.
meta	array<string,mixed>	Optional	Additional metadata for the user. Maximum 50 fields.

classUserCurrency2 fields

Field	Type	Requirement	Description
code	string	Required	|
symbol	string	Required	|

classUserPasswordResetRequest1 fields

Field	Type	Requirement	Description
packageId	string	Optional	Package whose order's proxy password should be rotated.

V

classVerifyOTPRequest2 fields

Field	Type	Requirement	Description
challenge	string	Required	|
code	string	Required	|

W

classWebhookCreateRequest6 fields

Field	Type	Requirement	Description
type	WebhookScopeEnum	Required	|
endpoint	string	Required	|
readTimeout	int	Required	| [optional] [default to 5]
writeTimeout	int	Required	| [optional] [default to 5]
retries	int	Required	| [optional] [default to 3]
retryTimeout	int	Required	| [optional] [default to 10]

classWebhookCreated9 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
type	WebhookScopeEnum	Optional	Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System
endpoint	string	Required	HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout. |
secret	string	Optional	Secret used to sign each webhook payload. The receiving endpoint should verify the signature to confirm the request originated from this platform. Auto-generated if left blank. Store this value securely on the receiving end.
readTimeout	int	Optional	Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.
writeTimeout	int	Optional	Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.
retries	int	Optional	Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts
retryTimeout	int	Optional	How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds
created	DateTime	Required	| [readonly]

classWebhookList8 fields

Field	Type	Requirement	Description
id	string	Required	| [optional]
type	WebhookScopeEnum	Optional	Context in which this webhook operates. Determines which events are delivered. User events scoped to the associated user account Reseller events scoped to the reseller and their sub-accounts System platform-wide system events * `user` - User * `reseller` - Reseller * `system` - System
endpoint	string	Required	HTTPS URL that receives webhook POST requests when events are triggered. https://example.com/webhooks/proxy The endpoint must be publicly accessible and respond within the configured read timeout. |
readTimeout	int	Optional	Maximum time to wait for the endpoint to return a response. Requests that exceed this limit are treated as failed and may be retried.
writeTimeout	int	Optional	Maximum time to wait while sending the payload to the endpoint. Requests that exceed this limit are treated as failed and may be retried.
retries	int	Optional	Number of additional delivery attempts after an initial failure. Set to 0 to disable retries. 3 → up to 4 total delivery attempts
retryTimeout	int	Optional	How long to wait before each retry attempt after a failed delivery. 10 → retry after 10 seconds
created	DateTime	Required	| [readonly]

enumWebhookScopeEnum0 fields

* `user` - User * `reseller` - Reseller * `system` - System

No configurable fields.