Invoices

SDK Reference · Resource

Invoices

Create purchases and inspect invoices, payment links, and receipts.

list()create()get()delete()downloadPdf()getPaymentLink()

method

list()

List invoices

Returns invoices visible to the authenticated account. Resellers and administrators can filter by an accessible user.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.invoices.list(options: InvoicesListOptions = {}): Promise<InvoicesListResponse>

Parameters

Name	Type	Requirement	Description
gateway	string	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
internalId	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.
packageId	string	Optional	—
search	string	Optional	Case-insensitive partial search across Invoice fields: `id`, `internal_id`, and `user.email`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
status	string	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
type	string	Optional	The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance
userEmail	string	Optional	—
userId	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

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

Returns

PaginatedInvoiceReadList

The operation completed successfully.

typePaginatedInvoiceReadList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

InvoiceRead[]

Required

—

typeInvoiceRead39fields

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

FieldTypeRequirementDescription

id

string

Optional

—

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

country

Country

Required

—

typeCountry6fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

string

Required

English display name of the country used across the admin and API responses.

original_name

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

user_id

string

Required

—

coupon

Coupon

Required

—

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.

payment_amount

number

Required

—

payment_currency

string

Required

—

fx_market_rate

string

Required

—

fx_effective_rate

string

Required

—

fx_markup_percent

string

Required

—

fx_quoted_at

string

Required

—

updated

string

Required

—

created

string

Required

—

type

InvoiceTypeEnum

Optional

The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance

enumInvoiceTypeEnum0fields

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

No fields.

is_one_time

boolean

Optional

Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.

is_payout

boolean

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internal_id

string

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error

enumInvoiceStatusEnum0fields

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

No fields.

description

string

Optional

A description of the invoice. This field is optional and can be left blank.

connection_limit

number

Optional

The maximum number of concurrent connections allowed for this package.

quantity

number

Optional

The number of proxies to assign.

data

number

Optional

The amount of data in bytes.

balance

number

Optional

The balance to top up for the user. Must be zero or positive.

price_total

number

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

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

No fields.

payment_url

string

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

string

Optional

ISO 4217 currency captured when the invoice is created.

provider_checkout_id

string

Optional

Provider-side hosted checkout identifier used for reconciliation.

provider_payment_id

string

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkout_status

CheckoutStatusEnum

Optional

—

enumCheckoutStatusEnum0fields

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

No fields.

vat

number

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

company_name

string

Optional

—

company_address

string

Optional

—

company_city

string

Optional

—

company_postal_code

string

Optional

—

company_registration_number

string

Optional

—

company_vat_number

string

Optional

—

paid

string

Optional

The date and time when the invoice was paid.

expires

string

Optional

The date and time when the invoice expires. If not set, the invoice does not expire.

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

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

Signature

Syncclient.invoices.list(*, gateway: InvoicesListPaymentGateway | Unset=UNSET, internal_id: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: str | Unset=UNSET, search: str | Unset=UNSET, status: InvoicesListStatus | Unset=UNSET, type_: InvoicesListType | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedInvoiceReadList

Asyncawait async_client.invoices.list(*, gateway: InvoicesListPaymentGateway | Unset=UNSET, internal_id: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: str | Unset=UNSET, search: str | Unset=UNSET, status: InvoicesListStatus | Unset=UNSET, type_: InvoicesListType | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedInvoiceReadList

Parameters

Name	Type	Requirement	Description
gateway	str	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
internal_id	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.
package_id	str	Optional	—
search	str	Optional	Case-insensitive partial search across Invoice fields: `id`, `internal_id`, and `user.email`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
status	str	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
type	str	Optional	The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance
user_email	str	Optional	—
user_id	str	Optional	—
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.invoices.list()

Async example

result = await async_client.invoices.list()

Returns

PaginatedInvoiceReadList

The operation completed successfully.

classPaginatedInvoiceReadList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[Invoice | InvoiceShort]

Required

—

classInvoice38fields

FieldTypeRequirementDescription

package

None | 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.

country

Country | None

Required

—

classCountry6fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

original_name

str

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

user_id

UUID

Required

—

coupon

CouponShort | None

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.

payment_amount

int

Required

—

payment_currency

str

Required

—

fx_market_rate

str

Required

—

fx_effective_rate

str

Required

—

fx_markup_percent

str

Required

—

fx_quoted_at

datetime.datetime | None

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

type_

InvoiceTypeEnum

Optional

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

enumInvoiceTypeEnum0fields

No fields.

is_one_time

bool

Optional

Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.

is_payout

bool

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internal_id

str

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

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

enumInvoiceStatusEnum0fields

No fields.

description

str

Optional

A description of the invoice. This field is optional and can be left blank.

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

quantity

int

Optional

The number of proxies to assign.

data

int

Optional

The amount of data in bytes.

balance

int

Optional

The balance to top up for the user. Must be zero or positive.

price_total

int

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

No fields.

payment_url

str

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

str

Optional

ISO 4217 currency captured when the invoice is created.

provider_checkout_id

str

Optional

Provider-side hosted checkout identifier used for reconciliation.

provider_payment_id

str

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkout_status

CheckoutStatusEnum

Optional

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

enumCheckoutStatusEnum0fields

No fields.

vat

float

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_registration_number

str

Optional

—

company_vat_number

str

Optional

—

paid

datetime.datetime | None

Optional

The date and time when the invoice was paid.

classInvoiceShort28fields

FieldTypeRequirementDescription

coupon

Coupon | None

Required

—

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.

country

Country | None

Required

—

classCountry6fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

original_name

str

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

is_one_time

bool

Optional

Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.

is_payout

bool

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internal_id

str

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

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

enumInvoiceStatusEnum0fields

No fields.

description

str

Optional

A description of the invoice. This field is optional and can be left blank.

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

data

int

Optional

The amount of data in bytes.

balance

int

Optional

The balance to top up for the user. Must be zero or positive.

price_total

int

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

No fields.

currency

str

Optional

ISO 4217 currency captured when the invoice is created.

provider_checkout_id

str

Optional

Provider-side hosted checkout identifier used for reconciliation.

provider_payment_id

str

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkout_status

CheckoutStatusEnum

Optional

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

enumCheckoutStatusEnum0fields

No fields.

vat

float

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_registration_number

str

Optional

—

company_vat_number

str

Optional

—

paid

datetime.datetime | None

Optional

The date and time when the invoice was paid.

expires

datetime.datetime | None

Optional

The date and time when the invoice expires. If not set, the invoice does not expire.

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.invoices.list_with_response(*, gateway: InvoicesListPaymentGateway | Unset=UNSET, internal_id: str | Unset=UNSET, limit: int | Unset=UNSET, offset: int | Unset=UNSET, ordering: str | Unset=UNSET, package_id: str | Unset=UNSET, search: str | Unset=UNSET, status: InvoicesListStatus | Unset=UNSET, type_: InvoicesListType | Unset=UNSET, user_email: str | Unset=UNSET, user_id: UUID | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedInvoiceReadList]

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

Signature

Sync$client->invoices()->list($gateway = null, $internalId = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $status = null, $type = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

Name	Type	Requirement	Description
gateway	string	Optional	The payment gateway used for processing the payment. * `coinbase` - Coinbase * `cryptomus` - Cryptomus * `stripe` - Stripe * `coingate` - Coingate * `wallet` - Wallet * `manual` - Manual * `whitepay` - Whitepay * `wayforpay` - WayForPay * `usegateway` - UseGateway * `binance` - Binance Pay * `anymoney` - Any.Money * `coinpayments` - CoinPayments * `checkoutcom` - Checkout.com * `nowpayments` - NOWPayments * `btcpay` - BTCPay Server * `braintree` - Braintree * `monobank` - monobank * `liqpay` - LiqPay * `iyzico` - iyzico * `paytr` - PayTR * `payu` - PayU * `tpay` - Tpay * `przelewy24` - Przelewy24 * `gopay` - GoPay * `comgate` - Comgate * `monei` - MONEI * `redsys` - Redsys * `payplug` - PayPlug * `mollie` - Mollie * `unzer` - Unzer * `payone` - PAYONE * `nexi_xpay` - Nexi XPay * `halyk_epay` - Halyk ePay * `kaspi_pay` - Kaspi Pay * `vipps_mobilepay` - Vipps MobilePay * `paytrail` - Paytrail
internalId	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.
packageId	string	Optional	—
search	string	Optional	Case-insensitive partial search across Invoice fields: `id`, `internal_id`, and `user.email`. Separate multiple terms with spaces or commas; every term must match at least one listed field.
status	string	Optional	After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error
type	string	Optional	The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance
userEmail	string	Optional	—
userId	string	Optional	—
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

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

Returns

PaginatedInvoiceReadList

The operation completed successfully.

classPaginatedInvoiceReadList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[InvoiceRead[]](InvoiceRead.md)

Required

|

classInvoiceRead39fields

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

FieldTypeRequirementDescription

id

string

Required

| [optional]

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

country

Country

Required

| [readonly]

classCountry6fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |

name

string

Required

English display name of the country used across the admin and API responses. |

originalName

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

userId

string

Required

| [readonly]

coupon

Coupon

Required

| [readonly]

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.

paymentAmount

int

Required

| [readonly]

paymentCurrency

string

Required

| [readonly]

fxMarketRate

string

Required

| [readonly]

fxEffectiveRate

string

Required

| [readonly]

fxMarkupPercent

string

Required

| [readonly]

fxQuotedAt

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

type

InvoiceTypeEnum

Optional

The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance

enumInvoiceTypeEnum0fields

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

No fields.

isOneTime

bool

Optional

Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.

isPayout

bool

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internalId

string

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error

enumInvoiceStatusEnum0fields

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

No fields.

description

string

Optional

A description of the invoice. This field is optional and can be left blank.

connectionLimit

int

Optional

The maximum number of concurrent connections allowed for this package.

quantity

int

Optional

The number of proxies to assign.

data

int

Optional

The amount of data in bytes.

balance

int

Optional

The balance to top up for the user. Must be zero or positive.

priceTotal

int

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

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

No fields.

paymentUrl

string

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

string

Optional

ISO 4217 currency captured when the invoice is created.

providerCheckoutId

string

Optional

Provider-side hosted checkout identifier used for reconciliation.

providerPaymentId

string

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkoutStatus

CheckoutStatusEnum

Required

| [optional]

enumCheckoutStatusEnum0fields

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

No fields.

vat

float

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

companyName

string

Required

| [optional]

companyAddress

string

Required

| [optional]

companyCity

string

Required

| [optional]

companyPostalCode

string

Required

| [optional]

companyRegistrationNumber

string

Required

| [optional]

companyVatNumber

string

Required

| [optional]

paid

DateTime

Optional

The date and time when the invoice was paid.

expires

DateTime

Optional

The date and time when the invoice expires. If not set, the invoice does not expire.

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->invoices()->listWithResponse($gateway = null, $internalId = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $status = null, $type = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->invoices()->listWithHttpInfo($gateway = null, $internalId = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $status = null, $type = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns the OpenAPI Generator response tuple.

• $client->invoices()->listAsync($gateway = null, $internalId = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $status = null, $type = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the decoded result.

• $client->invoices()->listAsyncWithHttpInfo($gateway = null, $internalId = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $status = null, $type = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the response tuple.

• $client->invoices()->listRequest($gateway = null, $internalId = null, $limit = null, $offset = null, $ordering = null, $packageId = null, $search = null, $status = null, $type = null, $userEmail = null, $userId = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Builds the PSR-7 request without sending it.

method

create()

Create an invoice

Calculates package pricing and initializes the selected payment provider when required. The status defaults to `pending`. Creating an already-paid invoice by setting `status` to `paid` requires a superuser or an active superuser's API key (Static or Bearer), including requests using `X-Impersonate-User`. Other authenticated users receive a an API failure response. During API-key impersonation, the invoice recipient and user_id access rules are still determined by the impersonated user. For wallet payments, omit `status`: the invoice is created as pending and becomes paid after the balance is debited successfully. For your own billing system, confirm payment on your backend before sending gateway=manual and status=paid with a superuser credential. Sending user_id also requires is_reseller; omit user_id for a purchase by the caller. Sub-users cannot create invoices themselves. A paid package purchase creates or tops up the recipient's order for that package. Repeated purchases reuse the order. Finite expiring purchases have separate data ledgers; compatible non-expiring purchases and unlimited packages may reuse a ledger. This is different from assigning a child quota with /users/{id}/data/add. An amount-only invoice tops up money, not data. Persist the invoice ID and use Idempotency-Key for retries. Before delivering access, read the paid invoice and the resulting order: fulfillment can be recovered asynchronously. Accounting webhooks do not include invoice.paid.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.invoices.create(options: InvoicesCreateOptions): Promise<InvoicesCreateResponse>

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

Example

const result = await client.invoices.create({
  body: {
    "gateway": "crypto"
  }
});

Returns

Invoice

The resource or action result was created successfully.

typeInvoice38fields

FieldTypeRequirementDescription

id

string

Optional

—

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

country

Country

Required

—

typeCountry6fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

string

Required

English display name of the country used across the admin and API responses.

original_name

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

user_id

string

Required

—

coupon

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.

payment_amount

number

Required

—

payment_currency

string

Required

—

fx_market_rate

string

Required

—

fx_effective_rate

string

Required

—

fx_markup_percent

string

Required

—

fx_quoted_at

string

Required

—

updated

string

Required

—

created

string

Required

—

type

InvoiceTypeEnum

Optional

The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance

enumInvoiceTypeEnum0fields

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

No fields.

is_one_time

boolean

Optional

Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.

is_payout

boolean

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internal_id

string

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

Payment state. A paid package invoice funds an order; a paid balance invoice credits money. Confirm the resulting order before delivering access, because fulfillment can recover asynchronously. Creating an invoice with status=paid requires a superuser. This read field is not a public status-update or refund endpoint. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error

enumInvoiceStatusEnum0fields

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

No fields.

description

string

Optional

A description of the invoice. This field is optional and can be left blank.

connection_limit

number

Optional

The maximum number of concurrent connections allowed for this package.

quantity

number

Optional

The number of proxies to assign.

data

number

Optional

The amount of data in bytes.

balance

number

Optional

The balance to top up for the user. Must be zero or positive.

price_total

number

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

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

No fields.

payment_url

string

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

string

Optional

ISO 4217 currency captured when the invoice is created.

provider_checkout_id

string

Optional

Provider-side hosted checkout identifier used for reconciliation.

provider_payment_id

string

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkout_status

CheckoutStatusEnum

Optional

—

enumCheckoutStatusEnum0fields

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

No fields.

vat

number

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

company_name

string

Optional

—

company_address

string

Optional

—

company_city

string

Optional

—

company_postal_code

string

Optional

—

company_registration_number

string

Optional

—

company_vat_number

string

Optional

—

paid

string

Optional

The date and time when the invoice was paid.

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: "server"ProxyRequest could not complete the 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.invoices.createWithResponse(options): Promise<ApiResponse<InvoicesCreateResponse>>

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

Signature

Syncclient.invoices.create(*, body: InvoiceCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Invoice

Asyncawait async_client.invoices.create(*, body: InvoiceCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> Invoice

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

Example

result = client.invoices.create(
        body=models.InvoiceCreateRequestRequest.from_dict({'gateway': 'crypto'}),
    )

Async example

result = await async_client.invoices.create(
        body=models.InvoiceCreateRequestRequest.from_dict({'gateway': 'crypto'}),
    )

Returns

Invoice

The resource or action result was created successfully.

classInvoice38fields

FieldTypeRequirementDescription

package

None | 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.

country

Country | None

Required

—

classCountry6fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

original_name

str

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

user_id

UUID

Required

—

coupon

CouponShort | None

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.

payment_amount

int

Required

—

payment_currency

str

Required

—

fx_market_rate

str

Required

—

fx_effective_rate

str

Required

—

fx_markup_percent

str

Required

—

fx_quoted_at

datetime.datetime | None

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

type_

InvoiceTypeEnum

Optional

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

enumInvoiceTypeEnum0fields

No fields.

is_one_time

bool

Optional

Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.

is_payout

bool

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internal_id

str

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

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

enumInvoiceStatusEnum0fields

No fields.

description

str

Optional

A description of the invoice. This field is optional and can be left blank.

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

quantity

int

Optional

The number of proxies to assign.

data

int

Optional

The amount of data in bytes.

balance

int

Optional

The balance to top up for the user. Must be zero or positive.

price_total

int

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

No fields.

payment_url

str

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

str

Optional

ISO 4217 currency captured when the invoice is created.

provider_checkout_id

str

Optional

Provider-side hosted checkout identifier used for reconciliation.

provider_payment_id

str

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkout_status

CheckoutStatusEnum

Optional

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

enumCheckoutStatusEnum0fields

No fields.

vat

float

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_registration_number

str

Optional

—

company_vat_number

str

Optional

—

paid

datetime.datetime | None

Optional

The date and time when the invoice was paid.

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.SERVERProxyRequest could not complete the 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.invoices.create_with_response(*, body: InvoiceCreateRequest, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[Invoice]

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

Signature

Sync$client->invoices()->create($invoiceCreateRequest, $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.
invoiceCreateRequest	InvoiceCreateRequest	Required	—

Example

$result = $client->invoices()->create(
    invoiceCreateRequest: new Dto\InvoiceCreateRequest([
        'gateway' => 'crypto',
    ]),
);

Returns

Invoice

The resource or action result was created successfully.

classInvoice38fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

country

Country

Required

| [readonly]

classCountry6fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |

name

string

Required

English display name of the country used across the admin and API responses. |

originalName

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

userId

string

Required

| [readonly]

coupon

CouponShort

Required

| [readonly]

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.

paymentAmount

int

Required

| [readonly]

paymentCurrency

string

Required

| [readonly]

fxMarketRate

string

Required

| [readonly]

fxEffectiveRate

string

Required

| [readonly]

fxMarkupPercent

string

Required

| [readonly]

fxQuotedAt

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

type

InvoiceTypeEnum

Optional

The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance

enumInvoiceTypeEnum0fields

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

No fields.

isOneTime

bool

Optional

Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.

isPayout

bool

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internalId

string

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

Payment state. A paid package invoice funds an order; a paid balance invoice credits money. Confirm the resulting order before delivering access, because fulfillment can recover asynchronously. Creating an invoice with status=paid requires a superuser. This read field is not a public status-update or refund endpoint. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error

enumInvoiceStatusEnum0fields

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

No fields.

description

string

Optional

A description of the invoice. This field is optional and can be left blank.

connectionLimit

int

Optional

The maximum number of concurrent connections allowed for this package.

quantity

int

Optional

The number of proxies to assign.

data

int

Optional

The amount of data in bytes.

balance

int

Optional

The balance to top up for the user. Must be zero or positive.

priceTotal

int

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

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

No fields.

paymentUrl

string

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

string

Optional

ISO 4217 currency captured when the invoice is created.

providerCheckoutId

string

Optional

Provider-side hosted checkout identifier used for reconciliation.

providerPaymentId

string

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkoutStatus

CheckoutStatusEnum

Required

| [optional]

enumCheckoutStatusEnum0fields

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

No fields.

vat

float

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

companyName

string

Required

| [optional]

companyAddress

string

Required

| [optional]

companyCity

string

Required

| [optional]

companyPostalCode

string

Required

| [optional]

companyRegistrationNumber

string

Required

| [optional]

companyVatNumber

string

Required

| [optional]

paid

DateTime

Optional

The date and time when the invoice was paid.

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::ServerProxyRequest could not complete the 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->invoices()->createWithResponse($invoiceCreateRequest, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['create'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

get()

Get an invoice

Returns billing, package, payment, and status details for one invoice visible to the authenticated account.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.invoices.get(options: InvoicesGetOptions): Promise<InvoicesGetResponse>

Parameters

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

Returns

InvoiceRead

The operation completed successfully.

typeInvoiceRead39fields

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

FieldTypeRequirementDescription

id

string

Optional

—

package

PackageShort

Required

—

typePackageShort5fields

FieldTypeRequirementDescription

id

string

Optional

—

name

string

Required

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

alias

string

Required

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

is_unlimited_data

boolean

Optional

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

targeting_options

TargetingOptions

Required

—

typeTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

—

split_char

string

Required

—

value_char

string

Required

—

continent

string

Required

—

country

string

Required

—

region

string

Required

—

city

string

Required

—

asn

string

Required

—

isp

string

Required

—

username

string

Required

—

pool

string

Required

—

location

string

Required

—

location_format

string

Required

—

session

string

Required

—

session_mode_tag

string

Required

—

session_ttl

string

Required

—

session_ttl_format

number

Required

—

os

string

Required

—

os_combined

boolean

Required

—

os_split_char

string

Required

—

os_linux

string

Required

—

os_windows

string

Required

—

os_ios

string

Required

—

os_macos

string

Required

—

os_android

string

Required

—

country

Country

Required

—

typeCountry6fields

FieldTypeRequirementDescription

id

string

Optional

—

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

string

Required

English display name of the country used across the admin and API responses.

original_name

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

LocationCodeName[]

Required

—

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

asns

LocationCodeName[]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

typeLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

—

name

string

Required

—

user_id

string

Required

—

coupon

Coupon

Required

—

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.

payment_amount

number

Required

—

payment_currency

string

Required

—

fx_market_rate

string

Required

—

fx_effective_rate

string

Required

—

fx_markup_percent

string

Required

—

fx_quoted_at

string

Required

—

updated

string

Required

—

created

string

Required

—

type

InvoiceTypeEnum

Optional

The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance

enumInvoiceTypeEnum0fields

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

No fields.

is_one_time

boolean

Optional

Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.

is_payout

boolean

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internal_id

string

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error

enumInvoiceStatusEnum0fields

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

No fields.

description

string

Optional

A description of the invoice. This field is optional and can be left blank.

connection_limit

number

Optional

The maximum number of concurrent connections allowed for this package.

quantity

number

Optional

The number of proxies to assign.

data

number

Optional

The amount of data in bytes.

balance

number

Optional

The balance to top up for the user. Must be zero or positive.

price_total

number

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

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

No fields.

payment_url

string

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

string

Optional

ISO 4217 currency captured when the invoice is created.

provider_checkout_id

string

Optional

Provider-side hosted checkout identifier used for reconciliation.

provider_payment_id

string

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkout_status

CheckoutStatusEnum

Optional

—

enumCheckoutStatusEnum0fields

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

No fields.

vat

number

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

company_name

string

Optional

—

company_address

string

Optional

—

company_city

string

Optional

—

company_postal_code

string

Optional

—

company_registration_number

string

Optional

—

company_vat_number

string

Optional

—

paid

string

Optional

The date and time when the invoice was paid.

expires

string

Optional

The date and time when the invoice expires. If not set, the invoice does not expire.

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.invoices.getWithResponse(options): Promise<ApiResponse<InvoicesGetResponse>>

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

Signature

Syncclient.invoices.get(id: str, *, accept_language: str | Unset=UNSET) -> Invoice | InvoiceShort

Asyncawait async_client.invoices.get(id: str, *, accept_language: str | Unset=UNSET) -> Invoice | InvoiceShort

Parameters

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

Async example

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

Returns

Invoice | InvoiceShort

The operation completed successfully.

classInvoice38fields

FieldTypeRequirementDescription

package

None | 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.

country

Country | None

Required

—

classCountry6fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

original_name

str

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

user_id

UUID

Required

—

coupon

CouponShort | None

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.

payment_amount

int

Required

—

payment_currency

str

Required

—

fx_market_rate

str

Required

—

fx_effective_rate

str

Required

—

fx_markup_percent

str

Required

—

fx_quoted_at

datetime.datetime | None

Required

—

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

type_

InvoiceTypeEnum

Optional

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

enumInvoiceTypeEnum0fields

No fields.

is_one_time

bool

Optional

Whether this pricing tier is restricted to a one-time purchase. False does not create a recurring subscription or a renewal schedule.

is_payout

bool

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internal_id

str

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

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

enumInvoiceStatusEnum0fields

No fields.

description

str

Optional

A description of the invoice. This field is optional and can be left blank.

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

quantity

int

Optional

The number of proxies to assign.

data

int

Optional

The amount of data in bytes.

balance

int

Optional

The balance to top up for the user. Must be zero or positive.

price_total

int

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

No fields.

payment_url

str

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

str

Optional

ISO 4217 currency captured when the invoice is created.

provider_checkout_id

str

Optional

Provider-side hosted checkout identifier used for reconciliation.

provider_payment_id

str

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkout_status

CheckoutStatusEnum

Optional

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

enumCheckoutStatusEnum0fields

No fields.

vat

float

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_registration_number

str

Optional

—

company_vat_number

str

Optional

—

paid

datetime.datetime | None

Optional

The date and time when the invoice was paid.

classInvoiceShort28fields

FieldTypeRequirementDescription

coupon

Coupon | None

Required

—

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.

country

Country | None

Required

—

classCountry6fields

FieldTypeRequirementDescription

code

str

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr

name

str

Required

English display name of the country used across the admin and API responses.

isps

list[LocationCodeName]

Required

—

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

asns

list[LocationCodeName]

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

str

Required

—

name

str

Required

—

id

str

Optional

—

original_name

str

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

updated

datetime.datetime

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

is_one_time

bool

Optional

Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.

is_payout

bool

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internal_id

str

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

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

enumInvoiceStatusEnum0fields

No fields.

description

str

Optional

A description of the invoice. This field is optional and can be left blank.

connection_limit

int

Optional

The maximum number of concurrent connections allowed for this package.

data

int

Optional

The amount of data in bytes.

balance

int

Optional

The balance to top up for the user. Must be zero or positive.

price_total

int

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

No fields.

currency

str

Optional

ISO 4217 currency captured when the invoice is created.

provider_checkout_id

str

Optional

Provider-side hosted checkout identifier used for reconciliation.

provider_payment_id

str

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkout_status

CheckoutStatusEnum

Optional

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

enumCheckoutStatusEnum0fields

No fields.

vat

float

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

company_name

str

Optional

—

company_address

str

Optional

—

company_city

str

Optional

—

company_postal_code

str

Optional

—

company_registration_number

str

Optional

—

company_vat_number

str

Optional

—

paid

datetime.datetime | None

Optional

The date and time when the invoice was paid.

expires

datetime.datetime | None

Optional

The date and time when the invoice expires. If not set, the invoice does not expire.

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.invoices.get_with_response(id: str, *, accept_language: str | Unset=UNSET) -> ApiResponse[Invoice | InvoiceShort]

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

Signature

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

Parameters

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

Returns

InvoiceRead

The operation completed successfully.

classInvoiceRead39fields

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

FieldTypeRequirementDescription

id

string

Required

| [optional]

package

PackageShort

Required

| [readonly]

classPackageShort5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

name

string

Required

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

alias

string

Required

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

isUnlimitedData

bool

Optional

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

targetingOptions

TargetingOptions

Required

| [readonly]

classTargetingOptions25fields

FieldTypeRequirementDescription

package

string

Required

|

splitChar

string

Required

|

valueChar

string

Required

|

continent

string

Required

|

country

string

Required

|

region

string

Required

|

city

string

Required

|

asn

string

Required

|

isp

string

Required

|

username

string

Required

|

pool

string

Required

|

location

string

Required

|

locationFormat

string

Required

|

session

string

Required

|

sessionModeTag

string

Required

|

sessionTtl

string

Required

|

sessionTtlFormat

int

Required

|

os

string

Required

|

osCombined

bool

Required

|

osSplitChar

string

Required

|

osLinux

string

Required

|

osWindows

string

Required

|

osIos

string

Required

|

osMacos

string

Required

|

osAndroid

string

Required

|

country

Country

Required

| [readonly]

classCountry6fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

code

string

Required

Two-letter ISO 3166-1 alpha-2 country code. Must be unique. us de fr |

name

string

Required

English display name of the country used across the admin and API responses. |

originalName

string

Optional

Native-language name of the country as it appears in the source data. Deutschland Français

isps

[LocationCodeName[]](LocationCodeName.md)

Required

| [readonly]

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

asns

[LocationCodeName[]](LocationCodeName.md)

Required

The asns field is always present and defaults to an empty array. Pass include_asns=true to include available autonomous system numbers. This option does not affect the standalone /locations/asn endpoint or the compact proxy-node response format.

classLocationCodeName2fields

FieldTypeRequirementDescription

code

string

Required

|

name

string

Required

|

userId

string

Required

| [readonly]

coupon

Coupon

Required

| [readonly]

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.

paymentAmount

int

Required

| [readonly]

paymentCurrency

string

Required

| [readonly]

fxMarketRate

string

Required

| [readonly]

fxEffectiveRate

string

Required

| [readonly]

fxMarkupPercent

string

Required

| [readonly]

fxQuotedAt

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

created

DateTime

Required

| [readonly]

type

InvoiceTypeEnum

Optional

The type of invoice, indicating the type of proxy service. Options include: RESIDENTIAL: Residential proxies. STATIC: Static proxies. * `static` - Static * `residential` - Residential * `balance` - Balance

enumInvoiceTypeEnum0fields

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

No fields.

isOneTime

bool

Optional

Indicates whether this invoice is for a one-time purchase. Default is False, meaning it is a recurring invoice.

isPayout

bool

Optional

Indicates whether this invoice is a payout to the marketer. Default is False.

internalId

string

Optional

A unique identifier for the invoice, generated automatically.

status

InvoiceStatusEnum

Optional

After changing invoice status to PAID, the invoice will be processed and user package created in case none exists. If you need to cancel the invoice, make sure to subtract data from the user package after changing the invoice status. Changing the status from PAID to any other will not affect the user package's data or proxies. * `pending` - Pending * `paid` - Paid * `unpaid` - Unpaid * `error` - Error

enumInvoiceStatusEnum0fields

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

No fields.

description

string

Optional

A description of the invoice. This field is optional and can be left blank.

connectionLimit

int

Optional

The maximum number of concurrent connections allowed for this package.

quantity

int

Optional

The number of proxies to assign.

data

int

Optional

The amount of data in bytes.

balance

int

Optional

The balance to top up for the user. Must be zero or positive.

priceTotal

int

Optional

The total price of the invoice, including any discounts. Must be at least 1 cent.

gateway

InvoiceGatewayEnum

Optional

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

enumInvoiceGatewayEnum0fields

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

No fields.

paymentUrl

string

Optional

The URL for making the payment. Optional field with a maximum length of 500 characters.

currency

string

Optional

ISO 4217 currency captured when the invoice is created.

providerCheckoutId

string

Optional

Provider-side hosted checkout identifier used for reconciliation.

providerPaymentId

string

Optional

Provider-side payment or transaction identifier used for reconciliation.

checkoutStatus

CheckoutStatusEnum

Required

| [optional]

enumCheckoutStatusEnum0fields

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

No fields.

vat

float

Optional

The VAT percentage applied to the invoice. Must be between 0 and 100.

companyName

string

Required

| [optional]

companyAddress

string

Required

| [optional]

companyCity

string

Required

| [optional]

companyPostalCode

string

Required

| [optional]

companyRegistrationNumber

string

Required

| [optional]

companyVatNumber

string

Required

| [optional]

paid

DateTime

Optional

The date and time when the invoice was paid.

expires

DateTime

Optional

The date and time when the invoice expires. If not set, the invoice does not expire.

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->invoices()->getWithResponse($id, $acceptLanguage = null, string $contentType = self::contentTypes['get'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

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

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

delete()

Delete an invoice

Deletes an invoice that the authenticated account is allowed to remove.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.invoices.delete(options: InvoicesDeleteOptions): Promise<InvoicesDeleteResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this Invoice.
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.invoices.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.invoices.deleteWithResponse(options): Promise<ApiResponse<InvoicesDeleteResponse>>

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

Signature

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

Asyncawait async_client.invoices.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 Invoice.
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.invoices.delete(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

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

Returns

None

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

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

Advanced variants

• client.invoices.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->invoices()->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 Invoice.
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->invoices()->delete(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

void

No response body

Throws

ApiException

Normalized API, transport, and response processing failure.

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

InvalidArgumentException

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

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->invoices()->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->invoices()->deleteWithHttpInfo($id, $idempotencyKey = null, $ifMatch = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns the OpenAPI Generator response tuple.

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

  Returns a Guzzle promise for the decoded result.

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

  Returns a Guzzle promise for the response tuple.

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

  Builds the PSR-7 request without sending it.

method

downloadPdf()

Download an invoice PDF

Returns the generated invoice document as a PDF attachment. The file may be downloaded from the billing provider on first access.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.invoices.downloadPdf(options: InvoicesDownloadPdfOptions): Promise<InvoicesDownloadPdfResponse>

Parameters

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

Returns

FileDownload

Invoice PDF document.

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.invoices.downloadPdfWithResponse(options): Promise<ApiResponse<InvoicesDownloadPdfResponse>>

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

Signature

Syncclient.invoices.download_pdf(id: str, *, accept_language: str | Unset=UNSET) -> FileDownload

Asyncawait async_client.invoices.download_pdf(id: str, *, accept_language: str | Unset=UNSET) -> FileDownload

Parameters

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

Async example

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

Returns

FileDownload

Invoice PDF document.

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.invoices.download_pdf_with_response(id: str, *, accept_language: str | Unset=UNSET) -> ApiResponse[FileDownload]

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

Signature

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

Parameters

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

Returns

FileDownload

Invoice PDF document.

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->invoices()->downloadPdfWithResponse($id, $acceptLanguage = null, string $contentType = self::contentTypes['downloadPdf'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->invoices()->downloadPdfWithHttpInfo($id, $acceptLanguage = null, string $contentType = self::contentTypes['downloadPdf'][0])

  Returns the OpenAPI Generator response tuple.

• $client->invoices()->downloadPdfAsync($id, $acceptLanguage = null, string $contentType = self::contentTypes['downloadPdf'][0])

  Returns a Guzzle promise for the decoded result.

• $client->invoices()->downloadPdfAsyncWithHttpInfo($id, $acceptLanguage = null, string $contentType = self::contentTypes['downloadPdf'][0])

  Returns a Guzzle promise for the response tuple.

• $client->invoices()->downloadPdfRequest($id, $acceptLanguage = null, string $contentType = self::contentTypes['downloadPdf'][0])

  Builds the PSR-7 request without sending it.

method

getPaymentLink()

Get an invoice payment link

Returns the hosted checkout URL for a pending invoice. Paid, cancelled, or expired invoices cannot produce a new payment link.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.invoices.getPaymentLink(options: InvoicesGetPaymentLinkOptions): Promise<InvoicesGetPaymentLinkResponse>

Parameters

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

Returns

PaymentLinkResponse

The operation completed successfully.

typePaymentLinkResponse1field

FieldTypeRequirementDescription

payment_url

string

Required

Hosted checkout URL for the pending invoice.

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.invoices.getPaymentLinkWithResponse(options): Promise<ApiResponse<InvoicesGetPaymentLinkResponse>>

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

Signature

Syncclient.invoices.get_payment_link(id: str, *, accept_language: str | Unset=UNSET) -> PaymentLinkResponse

Asyncawait async_client.invoices.get_payment_link(id: str, *, accept_language: str | Unset=UNSET) -> PaymentLinkResponse

Parameters

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

Async example

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

Returns

PaymentLinkResponse

The operation completed successfully.

classPaymentLinkResponse1field

FieldTypeRequirementDescription

payment_url

str

Required

Hosted checkout URL for the pending invoice.

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.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.invoices.get_payment_link_with_response(id: str, *, accept_language: str | Unset=UNSET) -> ApiResponse[PaymentLinkResponse]

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

Signature

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

Parameters

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

Returns

PaymentLinkResponse

The operation completed successfully.

classPaymentLinkResponse1field

FieldTypeRequirementDescription

paymentUrl

string

Required

Hosted checkout URL for the pending invoice. |

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::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->invoices()->getPaymentLinkWithResponse($id, $acceptLanguage = null, string $contentType = self::contentTypes['getPaymentLink'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->invoices()->getPaymentLinkWithHttpInfo($id, $acceptLanguage = null, string $contentType = self::contentTypes['getPaymentLink'][0])

  Returns the OpenAPI Generator response tuple.

• $client->invoices()->getPaymentLinkAsync($id, $acceptLanguage = null, string $contentType = self::contentTypes['getPaymentLink'][0])

  Returns a Guzzle promise for the decoded result.

• $client->invoices()->getPaymentLinkAsyncWithHttpInfo($id, $acceptLanguage = null, string $contentType = self::contentTypes['getPaymentLink'][0])

  Returns a Guzzle promise for the response tuple.

• $client->invoices()->getPaymentLinkRequest($id, $acceptLanguage = null, string $contentType = self::contentTypes['getPaymentLink'][0])

  Builds the PSR-7 request without sending it.