Affiliates

SDK Reference · Resource

Affiliates

Inspect referred accounts and affiliate earnings.

list()listRewards()getRewardsOverall()

method

list()

List referred customers

Returns customers attributed to the authenticated affiliate together with the referral information available to that account.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.affiliates.list(options: AffiliatesListOptions = {}): Promise<AffiliatesListResponse>

Parameters

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

Example

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

Returns

PaginatedAffiliateList

The operation completed successfully.

typePaginatedAffiliateList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

Affiliate[]

Required

—

typeAffiliate5fields

FieldTypeRequirementDescription

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

—

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.affiliates.listWithResponse(options): Promise<ApiResponse<AffiliatesListResponse>>

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

Signature

Syncclient.affiliates.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedAffiliateList

Asyncawait async_client.affiliates.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedAffiliateList

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.affiliates.list()

Async example

result = await async_client.affiliates.list()

Returns

PaginatedAffiliateList

The operation completed successfully.

classPaginatedAffiliateList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[Affiliate]

Required

—

classAffiliate5fields

FieldTypeRequirementDescription

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

—

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.affiliates.list_with_response(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedAffiliateList]

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

Signature

Sync$client->affiliates()->list($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

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

Example

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

Returns

PaginatedAffiliateList

The operation completed successfully.

classPaginatedAffiliateList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[Affiliate[]](Affiliate.md)

Required

|

classAffiliate5fields

FieldTypeRequirementDescription

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]

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->affiliates()->listWithResponse($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->affiliates()->listWithHttpInfo($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns the OpenAPI Generator response tuple.

• $client->affiliates()->listAsync($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the decoded result.

• $client->affiliates()->listAsyncWithHttpInfo($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the response tuple.

• $client->affiliates()->listRequest($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Builds the PSR-7 request without sending it.

method

listRewards()

List affiliate reward entries

Returns individual reward entries generated by customers attributed to the authenticated marketer.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.affiliates.listRewards(options: AffiliatesListRewardsOptions = {}): Promise<AffiliatesListRewardsResponse>

Parameters

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

Example

const result = await client.affiliates.listRewards();

Returns

PaginatedAffiliateRewardList

The operation completed successfully.

typePaginatedAffiliateRewardList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

AffiliateReward[]

Required

—

typeAffiliateReward8fields

FieldTypeRequirementDescription

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

enumRewardStatusEnum0fields

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

No fields.

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

price_total

number

Required

—

data

number

Optional

The amount of data in bytes.

commission_amount

number

Required

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.affiliates.listRewardsWithResponse(options): Promise<ApiResponse<AffiliatesListRewardsResponse>>

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

Signature

Syncclient.affiliates.list_rewards(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedAffiliateRewardList

Asyncawait async_client.affiliates.list_rewards(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedAffiliateRewardList

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.affiliates.list_rewards()

Async example

result = await async_client.affiliates.list_rewards()

Returns

PaginatedAffiliateRewardList

The operation completed successfully.

classPaginatedAffiliateRewardList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[AffiliateReward]

Required

—

classAffiliateReward8fields

FieldTypeRequirementDescription

email

str

Required

—

package

PackageShort

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

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

enumRewardStatusEnum0fields

No fields.

data

int

Optional

The amount of data in bytes.

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.affiliates.list_rewards_with_response(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedAffiliateRewardList]

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

Signature

Sync$client->affiliates()->listRewards($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRewards'][0])

Parameters

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

Example

$result = $client->affiliates()->listRewards();

Returns

PaginatedAffiliateRewardList

The operation completed successfully.

classPaginatedAffiliateRewardList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[AffiliateReward[]](AffiliateReward.md)

Required

|

classAffiliateReward8fields

FieldTypeRequirementDescription

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

enumRewardStatusEnum0fields

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

No fields.

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

priceTotal

int

Required

| [readonly]

data

int

Optional

The amount of data in bytes.

commissionAmount

int

Required

| [readonly]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->affiliates()->listRewardsWithResponse($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRewards'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->affiliates()->listRewardsWithHttpInfo($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRewards'][0])

  Returns the OpenAPI Generator response tuple.

• $client->affiliates()->listRewardsAsync($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRewards'][0])

  Returns a Guzzle promise for the decoded result.

• $client->affiliates()->listRewardsAsyncWithHttpInfo($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRewards'][0])

  Returns a Guzzle promise for the response tuple.

• $client->affiliates()->listRewardsRequest($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRewards'][0])

  Builds the PSR-7 request without sending it.

method

getRewardsOverall()

Get affiliate earnings over time

Returns affiliate reward totals for the requested date range. start, end, and timezone use the same rules as analytics endpoints.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.affiliates.getRewardsOverall(options: AffiliatesGetRewardsOverallOptions = {}): Promise<AffiliatesGetRewardsOverallResponse>

Parameters

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

Example

const result = await client.affiliates.getRewardsOverall();

Returns

AffiliateStatsResponse

The operation completed successfully.

typeAffiliateStatsResponse1field

FieldTypeRequirementDescription

results

AffiliateStatsPoint[]

Required

—

typeAffiliateStatsPoint4fields

FieldTypeRequirementDescription

date

string

Optional

—

balance

number

Optional

—

data

number

Optional

—

count

number

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.affiliates.getRewardsOverallWithResponse(options): Promise<ApiResponse<AffiliatesGetRewardsOverallResponse>>

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

Signature

Syncclient.affiliates.get_rewards_overall(*, accept_language: str | Unset=UNSET) -> AffiliateStatsResponse

Asyncawait async_client.affiliates.get_rewards_overall(*, accept_language: str | Unset=UNSET) -> AffiliateStatsResponse

Parameters

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

Example

result = client.affiliates.get_rewards_overall()

Async example

result = await async_client.affiliates.get_rewards_overall()

Returns

AffiliateStatsResponse

The operation completed successfully.

classAffiliateStatsResponse1field

FieldTypeRequirementDescription

results

list[AffiliateStatsPoint]

Required

—

classAffiliateStatsPoint4fields

FieldTypeRequirementDescription

date

datetime.date

Optional

—

balance

float

Optional

—

data

int

Optional

—

count

int

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.affiliates.get_rewards_overall_with_response(*, accept_language: str | Unset=UNSET) -> ApiResponse[AffiliateStatsResponse]

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

Signature

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

Parameters

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

Example

$result = $client->affiliates()->getRewardsOverall();

Returns

AffiliateStatsResponse

The operation completed successfully.

classAffiliateStatsResponse1field

FieldTypeRequirementDescription

results

[AffiliateStatsPoint[]](AffiliateStatsPoint.md)

Required

|

classAffiliateStatsPoint4fields

FieldTypeRequirementDescription

date

DateTime

Required

| [optional]

balance

float

Required

| [optional]

data

int

Required

| [optional]

count

int

Required

| [optional]

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->affiliates()->getRewardsOverallWithResponse($acceptLanguage = null, string $contentType = self::contentTypes['getRewardsOverall'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->affiliates()->getRewardsOverallWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['getRewardsOverall'][0])

  Returns the OpenAPI Generator response tuple.

• $client->affiliates()->getRewardsOverallAsync($acceptLanguage = null, string $contentType = self::contentTypes['getRewardsOverall'][0])

  Returns a Guzzle promise for the decoded result.

• $client->affiliates()->getRewardsOverallAsyncWithHttpInfo($acceptLanguage = null, string $contentType = self::contentTypes['getRewardsOverall'][0])

  Returns a Guzzle promise for the response tuple.

• $client->affiliates()->getRewardsOverallRequest($acceptLanguage = null, string $contentType = self::contentTypes['getRewardsOverall'][0])

  Builds the PSR-7 request without sending it.