Coupons

SDK Reference · Resource

Coupons

Create, validate, redeem, and inspect discount coupons.

list()create()get()replace()update()delete()listRedeems()calculatePrice()

method

list()

List available coupons

Returns coupons visible to the authenticated account. Staff accounts receive administrative fields; customers receive the public coupon view.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.coupons.list(options: CouponsListOptions = {}): Promise<CouponsListResponse>

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
search	string	Optional	Case-insensitive partial search across Coupon fields: `title` and `content`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
type	string	Optional	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
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.coupons.list();

Returns

PaginatedCouponShortList

The operation completed successfully.

typePaginatedCouponShortList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

CouponShort[]

Required

—

typeCouponShort14fields

FieldTypeRequirementDescription

id

string

Optional

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

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

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

Signature

Syncclient.coupons.list(*, code: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, search: str | Unset=UNSET, type_: CouponsListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedCouponShortList

Asyncawait async_client.coupons.list(*, code: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, search: str | Unset=UNSET, type_: CouponsListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedCouponShortList

Parameters

Name	Type	Requirement	Description
code	str	Optional	—
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
search	str	Optional	Case-insensitive partial search across Coupon fields: `title` and `content`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
type	str	Optional	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
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.coupons.list()

Async example

result = await async_client.coupons.list()

Returns

PaginatedCouponShortList

The operation completed successfully.

classPaginatedCouponShortList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[CouponShort]

Required

—

classCouponShort14fields

FieldTypeRequirementDescription

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

created

datetime.datetime

Required

—

value

int

Required

Arbitrary coupon value

code

str

Required

Leaving this field empty will generate a random code.

type_

CouponTypeEnum

Required

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

If true, coupon can not be used for one-time package tiers.

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

The marketer who owns this coupon. Required if is_marketer is true.

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.coupons.list_with_response(*, code: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, search: str | Unset=UNSET, type_: CouponsListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedCouponShortList]

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

Signature

Sync$client->coupons()->list($code = null, $limit = null, $offset = null, $ordering = null, $search = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
search	string	Optional	Case-insensitive partial search across Coupon fields: `title` and `content`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
type	string	Optional	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
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->coupons()->list();

Returns

PaginatedCouponShortList

The operation completed successfully.

classPaginatedCouponShortList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[CouponShort[]](CouponShort.md)

Required

|

classCouponShort14fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

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->coupons()->listWithResponse($code = null, $limit = null, $offset = null, $ordering = null, $search = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

create()

Create a coupon

Creates a coupon. This operation is restricted to administrators.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.coupons.create(options: CouponsCreateOptions): Promise<CouponsCreateResponse>

Parameters

Name	Type	Requirement	Description
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	CouponCreateRequest	Required	—

Example

const result = await client.coupons.create({
  body: {
    "value": -9223372036854776000,
    "type": "free_data"
  }
});

Returns

Coupon

The resource or action result was created successfully.

typeCoupon16fields

FieldTypeRequirementDescription

id

string

Optional

—

redeemed_count

number

Required

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

stats

CouponStats

Required

—

typeCouponStats5fields

FieldTypeRequirementDescription

total_redeems

number

Required

—

unique_users

number

Required

—

total_revenue

number

Required

—

total_discount_given

number

Required

—

total_data_given

number

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

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: "conflict"The operation conflicts with the current resource or idempotency state.
• 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.coupons.createWithResponse(options): Promise<ApiResponse<CouponsCreateResponse>>

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

Signature

Syncclient.coupons.create(*, body: CouponCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Coupon

Asyncawait async_client.coupons.create(*, body: CouponCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Coupon

Parameters

Name	Type	Requirement	Description
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	CouponCreateRequest	Required	—

Example

result = client.coupons.create(
        body=models.CouponCreateRequest.from_dict({'value': -9223372036854775808, 'type': 'free_data'}),
    )

Async example

result = await async_client.coupons.create(
        body=models.CouponCreateRequest.from_dict({'value': -9223372036854775808, 'type': 'free_data'}),
    )

Returns

Coupon

The resource or action result was created successfully.

classCoupon16fields

FieldTypeRequirementDescription

redeemed_count

int

Required

—

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

stats

CouponStats | None

Required

—

classCouponStats5fields

FieldTypeRequirementDescription

total_redeems

int

Required

—

unique_users

int

Required

—

total_revenue

int

Required

—

total_discount_given

int

Required

—

total_data_given

int

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

If true, coupon can not be used for one-time package tiers.

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

The marketer who owns this coupon. Required if is_marketer is true.

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.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.coupons.create_with_response(*, body: CouponCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[Coupon]

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

Signature

Sync$client->coupons()->create($couponCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

Parameters

Name	Type	Requirement	Description
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
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.
couponCreateRequest	CouponCreateRequest	Required	—

Example

$result = $client->coupons()->create(
    couponCreateRequest: new Dto\CouponCreateRequest([
        'value' => -9223372036854775807-1,
        'type' => 'free_data',
    ]),
);

Returns

Coupon

The resource or action result was created successfully.

classCoupon16fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

redeemedCount

int

Required

| [readonly]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

stats

CouponStats

Required

| [readonly]

classCouponStats5fields

FieldTypeRequirementDescription

totalRedeems

int

Required

|

uniqueUsers

int

Required

|

totalRevenue

int

Required

|

totalDiscountGiven

int

Required

|

totalDataGiven

int

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

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::ConflictThe operation conflicts with the current resource or idempotency state.
• 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->coupons()->createWithResponse($couponCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->coupons()->createWithHttpInfo($couponCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns the OpenAPI Generator response tuple.

• $client->coupons()->createAsync($couponCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns a Guzzle promise for the decoded result.

• $client->coupons()->createAsyncWithHttpInfo($couponCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Returns a Guzzle promise for the response tuple.

• $client->coupons()->createRequest($couponCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0])

  Builds the PSR-7 request without sending it.

method

get()

Get a coupon

Returns one coupon visible within the caller's account scope.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.coupons.get(options: CouponsGetOptions): Promise<CouponsGetResponse>

Parameters

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

Returns

CouponShort

The operation completed successfully.

typeCouponShort14fields

FieldTypeRequirementDescription

id

string

Optional

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.coupons.getWithResponse(options): Promise<ApiResponse<CouponsGetResponse>>

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

Signature

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

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

Parameters

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

Async example

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

Returns

CouponShort

The operation completed successfully.

classCouponShort14fields

FieldTypeRequirementDescription

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

created

datetime.datetime

Required

—

value

int

Required

Arbitrary coupon value

code

str

Required

Leaving this field empty will generate a random code.

type_

CouponTypeEnum

Required

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

If true, coupon can not be used for one-time package tiers.

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

The marketer who owns this coupon. Required if is_marketer is true.

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

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

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

Signature

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

Parameters

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

Returns

CouponShort

The operation completed successfully.

classCouponShort14fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

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

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

replace()

Replace a coupon

Replaces the writable fields of a coupon. Staff access is required.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.coupons.replace(options: CouponsReplaceOptions): Promise<CouponsReplaceResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Coupon.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	CouponUpdateRequest	Required	—

Example

const result = await client.coupons.replace({
  id: "550e8400-e29b-41d4-a716-446655440000",
  body: {
    "value": -9223372036854776000,
    "type": "free_data"
  }
});

Returns

Coupon

The operation completed successfully.

typeCoupon16fields

FieldTypeRequirementDescription

id

string

Optional

—

redeemed_count

number

Required

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

stats

CouponStats

Required

—

typeCouponStats5fields

FieldTypeRequirementDescription

total_redeems

number

Required

—

unique_users

number

Required

—

total_revenue

number

Required

—

total_discount_given

number

Required

—

total_data_given

number

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.coupons.replaceWithResponse(options): Promise<ApiResponse<CouponsReplaceResponse>>

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

Signature

Syncclient.coupons.replace(id: str, *, body: CouponUpdateRequest, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Coupon

Asyncawait async_client.coupons.replace(id: str, *, body: CouponUpdateRequest, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Coupon

Parameters

Name	Type	Requirement	Description
id	str	Required	A unique value identifying this Coupon.
if_match	str	Optional	Strong ETag from the latest representation of this resource.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	CouponUpdateRequest	Required	—

Example

result = client.coupons.replace(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.CouponUpdateRequest.from_dict({'value': -9223372036854775808, 'type': 'free_data'}),
    )

Async example

result = await async_client.coupons.replace(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.CouponUpdateRequest.from_dict({'value': -9223372036854775808, 'type': 'free_data'}),
    )

Returns

Coupon

The operation completed successfully.

classCoupon16fields

FieldTypeRequirementDescription

redeemed_count

int

Required

—

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

stats

CouponStats | None

Required

—

classCouponStats5fields

FieldTypeRequirementDescription

total_redeems

int

Required

—

unique_users

int

Required

—

total_revenue

int

Required

—

total_discount_given

int

Required

—

total_data_given

int

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

If true, coupon can not be used for one-time package tiers.

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

The marketer who owns this coupon. Required if is_marketer is true.

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.coupons.replace_with_response(id: str, *, body: CouponUpdateRequest, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[Coupon]

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

Signature

Sync$client->coupons()->replace($id, $couponUpdateRequest, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['replace'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Coupon.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
couponUpdateRequest	CouponUpdateRequest	Required	—

Example

$result = $client->coupons()->replace(
    id: '550e8400-e29b-41d4-a716-446655440000',
    couponUpdateRequest: new Dto\CouponUpdateRequest([
        'value' => -9223372036854775807-1,
        'type' => 'free_data',
    ]),
);

Returns

Coupon

The operation completed successfully.

classCoupon16fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

redeemedCount

int

Required

| [readonly]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

stats

CouponStats

Required

| [readonly]

classCouponStats5fields

FieldTypeRequirementDescription

totalRedeems

int

Required

|

uniqueUsers

int

Required

|

totalRevenue

int

Required

|

totalDiscountGiven

int

Required

|

totalDataGiven

int

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->coupons()->replaceWithResponse($id, $couponUpdateRequest, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['replace'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->coupons()->replaceWithHttpInfo($id, $couponUpdateRequest, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['replace'][0])

  Returns the OpenAPI Generator response tuple.

• $client->coupons()->replaceAsync($id, $couponUpdateRequest, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['replace'][0])

  Returns a Guzzle promise for the decoded result.

• $client->coupons()->replaceAsyncWithHttpInfo($id, $couponUpdateRequest, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['replace'][0])

  Returns a Guzzle promise for the response tuple.

• $client->coupons()->replaceRequest($id, $couponUpdateRequest, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['replace'][0])

  Builds the PSR-7 request without sending it.

method

update()

Update a coupon

Updates selected coupon fields. Staff access is required.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.coupons.update(options: CouponsUpdateOptions): Promise<CouponsUpdateResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Coupon.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	PatchedCouponUpdateRequest	Optional	—

Example

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

Returns

Coupon

The operation completed successfully.

typeCoupon16fields

FieldTypeRequirementDescription

id

string

Optional

—

redeemed_count

number

Required

—

is_expired

boolean

Required

—

is_redeemed

boolean

Required

—

packages

PackageShort[]

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

stats

CouponStats

Required

—

typeCouponStats5fields

FieldTypeRequirementDescription

total_redeems

number

Required

—

unique_users

number

Required

—

total_revenue

number

Required

—

total_discount_given

number

Required

—

total_data_given

number

Required

—

created

string

Required

—

value

number

Required

Arbitrary coupon value

code

string

Required

Leaving this field empty will generate a random code.

is_multi_use

boolean

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

boolean

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

—

enumCouponTypeEnum0fields

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

No fields.

limit

number

Optional

Number of times coupon can be used

valid_until

string

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.coupons.updateWithResponse(options): Promise<ApiResponse<CouponsUpdateResponse>>

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

Signature

Syncclient.coupons.update(id: str, *, body: PatchedCouponUpdateRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Coupon

Asyncawait async_client.coupons.update(id: str, *, body: PatchedCouponUpdateRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Coupon

Parameters

Name	Type	Requirement	Description
id	str	Required	A unique value identifying this Coupon.
if_match	str	Optional	Strong ETag from the latest representation of this resource.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	PatchedCouponUpdateRequest	Optional	—

Example

result = client.coupons.update(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.PatchedCouponUpdateRequest.from_dict({}),
    )

Async example

result = await async_client.coupons.update(
        id='550e8400-e29b-41d4-a716-446655440000',
        body=models.PatchedCouponUpdateRequest.from_dict({}),
    )

Returns

Coupon

The operation completed successfully.

classCoupon16fields

FieldTypeRequirementDescription

redeemed_count

int

Required

—

is_expired

bool

Required

—

is_redeemed

bool

Required

—

packages

list[PackageShort]

Required

—

classPackageShort5fields

FieldTypeRequirementDescription

name

str

Required

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

alias

str

Required

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

targeting_options

TargetingOptions

Required

—

classTargetingOptions25fields

FieldTypeRequirementDescription

package

str

Required

—

split_char

str

Required

—

value_char

str

Required

—

continent

str

Required

—

country

str

Required

—

region

str

Required

—

city

str

Required

—

asn

str

Required

—

isp

str

Required

—

username

str

Required

—

pool

str

Required

—

location

str

Required

—

location_format

str

Required

—

session

str

Required

—

session_mode_tag

str

Required

—

session_ttl

str

Required

—

session_ttl_format

int

Required

—

os

str

Required

—

os_combined

bool

Required

—

os_split_char

str

Required

—

os_linux

str

Required

—

os_windows

str

Required

—

os_ios

str

Required

—

os_macos

str

Required

—

os_android

str

Required

—

id

str

Optional

—

is_unlimited_data

bool

Optional

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

stats

CouponStats | None

Required

—

classCouponStats5fields

FieldTypeRequirementDescription

total_redeems

int

Required

—

unique_users

int

Required

—

total_revenue

int

Required

—

total_discount_given

int

Required

—

total_data_given

int

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

enumCouponTypeEnum0fields

No fields.

user

None | UUID

Required

The user who created this coupon.

id

str

Optional

—

is_multi_use

bool

Optional

If true, coupon can be used multiple times.

is_available_to_one_time

bool

Optional

If true, coupon can not be used for one-time package tiers.

limit

int

Optional

Number of times coupon can be used

valid_until

datetime.datetime | None

Optional

Leave empty for coupons that never expire

marketer

None | UUID

Optional

The marketer who owns this coupon. Required if is_marketer is true.

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.coupons.update_with_response(id: str, *, body: PatchedCouponUpdateRequest | Unset=UNSET, if_match: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[Coupon]

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

Signature

Sync$client->coupons()->update($id, $ifMatch = null, $acceptLanguage = null, $patchedCouponUpdateRequest = null, string $contentType = self::contentTypes['update'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Coupon.
ifMatch	string	Optional	Strong ETag from the latest representation of this resource.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
patchedCouponUpdateRequest	PatchedCouponUpdateRequest	Optional	—

Example

$result = $client->coupons()->update(
    id: '550e8400-e29b-41d4-a716-446655440000',
    patchedCouponUpdateRequest: new Dto\PatchedCouponUpdateRequest([]),
);

Returns

Coupon

The operation completed successfully.

classCoupon16fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

redeemedCount

int

Required

| [readonly]

isExpired

bool

Required

| [readonly]

isRedeemed

bool

Required

| [readonly]

packages

[PackageShort[]](PackageShort.md)

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

stats

CouponStats

Required

| [readonly]

classCouponStats5fields

FieldTypeRequirementDescription

totalRedeems

int

Required

|

uniqueUsers

int

Required

|

totalRevenue

int

Required

|

totalDiscountGiven

int

Required

|

totalDataGiven

int

Required

|

created

DateTime

Required

| [readonly]

value

int

Required

Arbitrary coupon value |

code

string

Required

Leaving this field empty will generate a random code.

isMultiUse

bool

Optional

If true, coupon can be used multiple times.

isAvailableToOneTime

bool

Optional

If true, coupon can not be used for one-time package tiers.

type

CouponTypeEnum

Required

|

enumCouponTypeEnum0fields

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

No fields.

limit

int

Optional

Number of times coupon can be used

validUntil

DateTime

Optional

Leave empty for coupons that never expire

marketer

string

Optional

The marketer who owns this coupon. Required if is_marketer is true.

user

string

Required

The user who created this coupon.

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->coupons()->updateWithResponse($id, $ifMatch = null, $acceptLanguage = null, $patchedCouponUpdateRequest = null, string $contentType = self::contentTypes['update'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

delete()

Delete a coupon

Deletes a coupon that is no longer needed. Staff access is required.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.coupons.delete(options: CouponsDeleteOptions): Promise<CouponsDeleteResponse>

Parameters

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

Example

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

Returns

void

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.coupons.deleteWithResponse(options): Promise<ApiResponse<CouponsDeleteResponse>>

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

Signature

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

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

Parameters

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

Example

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

Async example

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

Returns

None

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

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

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

Signature

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

Parameters

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

Example

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

Returns

void

No response body

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

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

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

listRedeems()

List coupon redemptions

Returns accounts and invoices that redeemed the selected coupon.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.coupons.listRedeems(options: CouponsListRedeemsOptions): Promise<CouponsListRedeemsResponse>

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
id	string	Required	A unique value identifying this Coupon.
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
type	string	Optional	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
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.coupons.listRedeems({
  id: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

PaginatedCouponRedeemList

The operation completed successfully.

typePaginatedCouponRedeemList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

CouponRedeem[]

Required

—

typeCouponRedeem7fields

FieldTypeRequirementDescription

id

string

Optional

—

user

string

Required

—

invoice

string

Optional

—

invoice_amount

number

Required

—

discount_applied

number

Required

—

redeemed_at

string

Optional

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "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.coupons.listRedeemsWithResponse(options): Promise<ApiResponse<CouponsListRedeemsResponse>>

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

Signature

Syncclient.coupons.list_redeems(id: str, *, code: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, type_: CouponsRedeemsListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedCouponRedeemList

Asyncawait async_client.coupons.list_redeems(id: str, *, code: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, type_: CouponsRedeemsListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedCouponRedeemList

Parameters

Name	Type	Requirement	Description
code	str	Optional	—
id	str	Required	A unique value identifying this Coupon.
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	str	Optional	Which field to use when ordering the results.
type	str	Optional	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
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.coupons.list_redeems(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

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

Returns

PaginatedCouponRedeemList

The operation completed successfully.

classPaginatedCouponRedeemList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[CouponRedeem]

Required

—

classCouponRedeem7fields

FieldTypeRequirementDescription

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

—

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.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.coupons.list_redeems_with_response(id: str, *, code: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, type_: CouponsRedeemsListType | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedCouponRedeemList]

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

Signature

Sync$client->coupons()->listRedeems($id, $code = null, $limit = null, $offset = null, $ordering = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRedeems'][0])

Parameters

Name	Type	Requirement	Description
code	string	Optional	—
id	string	Required	A unique value identifying this Coupon.
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
ordering	string	Optional	Which field to use when ordering the results.
type	string	Optional	* `free_data` - Free Data * `monetary` - Money * `percentage` - Percentage
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->coupons()->listRedeems(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

PaginatedCouponRedeemList

The operation completed successfully.

classPaginatedCouponRedeemList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[CouponRedeem[]](CouponRedeem.md)

Required

|

classCouponRedeem7fields

FieldTypeRequirementDescription

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]

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->coupons()->listRedeemsWithResponse($id, $code = null, $limit = null, $offset = null, $ordering = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRedeems'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->coupons()->listRedeemsWithHttpInfo($id, $code = null, $limit = null, $offset = null, $ordering = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRedeems'][0])

  Returns the OpenAPI Generator response tuple.

• $client->coupons()->listRedeemsAsync($id, $code = null, $limit = null, $offset = null, $ordering = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRedeems'][0])

  Returns a Guzzle promise for the decoded result.

• $client->coupons()->listRedeemsAsyncWithHttpInfo($id, $code = null, $limit = null, $offset = null, $ordering = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRedeems'][0])

  Returns a Guzzle promise for the response tuple.

• $client->coupons()->listRedeemsRequest($id, $code = null, $limit = null, $offset = null, $ordering = null, $type = null, $acceptLanguage = null, string $contentType = self::contentTypes['listRedeems'][0])

  Builds the PSR-7 request without sending it.

method

calculatePrice()

Calculate a discounted price

Validates a coupon against the selected package and data amount, then returns both the original and discounted prices without creating an invoice.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.coupons.calculatePrice(options: CouponsCalculatePriceOptions): Promise<CouponsCalculatePriceResponse>

Parameters

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

Example

const result = await client.coupons.calculatePrice({
  body: {
    "coupon_code": "{coupon_code}",
    "data": 1073741824
  }
});

Returns

CouponPriceResponse

The operation completed successfully.

typeCouponPriceResponse3fields

FieldTypeRequirementDescription

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

—

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.coupons.calculatePriceWithResponse(options): Promise<ApiResponse<CouponsCalculatePriceResponse>>

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

Signature

Syncclient.coupons.calculate_price(*, body: CouponCalculatePriceRequest, accept_language: str | Unset=UNSET) -> CouponPriceResponse

Asyncawait async_client.coupons.calculate_price(*, body: CouponCalculatePriceRequest, accept_language: str | Unset=UNSET) -> CouponPriceResponse

Parameters

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

Example

result = client.coupons.calculate_price(
        body=models.CouponCalculatePriceRequest.from_dict({'coupon_code': '{coupon_code}', 'data': 1073741824}),
    )

Async example

result = await async_client.coupons.calculate_price(
        body=models.CouponCalculatePriceRequest.from_dict({'coupon_code': '{coupon_code}', 'data': 1073741824}),
    )

Returns

CouponPriceResponse

The operation completed successfully.

classCouponPriceResponse3fields

FieldTypeRequirementDescription

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

—

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.coupons.calculate_price_with_response(*, body: CouponCalculatePriceRequest, accept_language: str | Unset=UNSET) -> ApiResponse[CouponPriceResponse]

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

Signature

Sync$client->coupons()->calculatePrice($couponCalculatePriceRequest, $acceptLanguage = null, string $contentType = self::contentTypes['calculatePrice'][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.
couponCalculatePriceRequest	CouponCalculatePriceRequest	Required	—

Example

$result = $client->coupons()->calculatePrice(
    couponCalculatePriceRequest: new Dto\CouponCalculatePriceRequest([
        'coupon_code' => '{coupon_code}',
        'data' => 1073741824,
    ]),
);

Returns

CouponPriceResponse

The operation completed successfully.

classCouponPriceResponse3fields

FieldTypeRequirementDescription

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

|

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->coupons()->calculatePriceWithResponse($couponCalculatePriceRequest, $acceptLanguage = null, string $contentType = self::contentTypes['calculatePrice'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->coupons()->calculatePriceWithHttpInfo($couponCalculatePriceRequest, $acceptLanguage = null, string $contentType = self::contentTypes['calculatePrice'][0])

  Returns the OpenAPI Generator response tuple.

• $client->coupons()->calculatePriceAsync($couponCalculatePriceRequest, $acceptLanguage = null, string $contentType = self::contentTypes['calculatePrice'][0])

  Returns a Guzzle promise for the decoded result.

• $client->coupons()->calculatePriceAsyncWithHttpInfo($couponCalculatePriceRequest, $acceptLanguage = null, string $contentType = self::contentTypes['calculatePrice'][0])

  Returns a Guzzle promise for the response tuple.

• $client->coupons()->calculatePriceRequest($couponCalculatePriceRequest, $acceptLanguage = null, string $contentType = self::contentTypes['calculatePrice'][0])

  Builds the PSR-7 request without sending it.