Skip to content

Packages

SDK Reference · Resource

Packages

Browse available proxy products, pricing, and targeting capabilities.

method

list()

List available proxy packages

Returns public packages and private packages already assigned to the authenticated account, including pricing and targeting capabilities.

Signature

Promiseclient.packages.list(options: PackagesListOptions = {}): Promise<PackagesListResponse>

Parameters

NameTypeRequirementDescription
aliasstringOptional—
limitnumberOptionalNumber of results to return per page.
offsetnumberOptionalThe initial index from which to return the results.
orderingstringOptionalWhich field to use when ordering the results.
pricingUnitstringOptionalUnit customers purchase — determines how the billing model amounts are interpreted. * `data` - Data * `proxy` - Proxy
searchstringOptionalCase-insensitive partial search across Package fields: `name` and `alias`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
typestringOptional* `static` - Static * `residential` - Residential
acceptLanguagestringOptionalPreferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

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

Returns

PaginatedPackageList

The operation completed successfully.

typePaginatedPackageList4fields
count
number
Required
—
next
string
Optional
—
previous
string
Optional
—
results
Package[]
Required
—
typePackage19fields
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
—
enumProxyTypeEnum0fields

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

No fields.

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
enumPricingEnum0fields

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

No fields.

pricing_unit
PricingUnitEnum
Optional
Unit customers purchase — determines how the billing model amounts are interpreted. * `data` - Data * `proxy` - Proxy
enumPricingUnitEnum0fields

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

No fields.

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
enumCommissionTypeEnum0fields

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

No fields.

targeting_options
TargetingOptions
Required
—
typeTargetingOptions25fields
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
—

Throws

ApiError

Normalized API, transport, and response processing failure.

  • kind: "validation"The request arguments or business rules are invalid.
  • kind: "authentication"Authentication credentials are missing, expired, or invalid.
  • kind: "permission"The authenticated account cannot perform this operation.
  • kind: "network"The request could not reach ProxyRequest.
  • kind: "unexpected"The response could not be decoded or did not match the SDK contract.
Advanced variants
  • client.packages.listWithResponse(options): Promise<ApiResponse<PackagesListResponse>>

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

method

listCommissions()

List affiliate package commissions

Returns commission rates, paid earnings, pending earnings, and referred order totals for each package visible to an approved marketer.

Signature

Promiseclient.packages.listCommissions(options: PackagesListCommissionsOptions = {}): Promise<PackagesListCommissionsResponse>

Parameters

NameTypeRequirementDescription
aliasstringOptional—
limitnumberOptionalNumber of results to return per page.
offsetnumberOptionalThe initial index from which to return the results.
orderingstringOptionalWhich field to use when ordering the results.
pricingUnitstringOptionalUnit customers purchase — determines how the billing model amounts are interpreted. * `data` - Data * `proxy` - Proxy
typestringOptional* `static` - Static * `residential` - Residential
acceptLanguagestringOptionalPreferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.packages.listCommissions();

Returns

PaginatedPackageCommissionList

The operation completed successfully.

typePaginatedPackageCommissionList4fields
count
number
Required
—
next
string
Optional
—
previous
string
Optional
—
results
PackageCommission[]
Required
—
typePackageCommission8fields
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
—

Throws

ApiError

Normalized API, transport, and response processing failure.

  • kind: "validation"The request arguments or business rules are invalid.
  • kind: "authentication"Authentication credentials are missing, expired, or invalid.
  • kind: "permission"The authenticated account cannot perform this operation.
  • kind: "network"The request could not reach ProxyRequest.
  • kind: "unexpected"The response could not be decoded or did not match the SDK contract.
Advanced variants
  • client.packages.listCommissionsWithResponse(options): Promise<ApiResponse<PackagesListCommissionsResponse>>

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