Models
ActiveProxyItemobjectShow propertiesHide properties
ipstringrequired
usernamestringrequired
passwordstringrequired
http_portintegerrequired
socks_portintegerrequired
untilstringrequired
ISO 8601 date string
statusstringrequired
signaturestring· nullableoptional
p0f signature assigned to the IP, null when not set
ApiErrorobjectShow propertiesHide properties
successbooleanrequired
messagestringrequired
AddonLineobjectOne add-on line stored on an order
Show propertiesHide properties
One add-on line stored on an order
addon_keystringoptional
catalog_idintegeroptional
qtyintegeroptional
Units active in the current period
price_per_unitintegeroptional
Unit price in cents at purchase time
pendingobject· nullableoptionalChange scheduled for the next renewal, or null
Show propertiesHide properties
Change scheduled for the next renewal, or null
actionstring · enumoptional
Possible values:
canceldowngradenext_qtyintegeroptional
Target quantity after downgrade
PurchaseRequestDcIspobjectPurchase for Datacenter/ISP; the location field is required.
Show propertiesHide properties
Purchase for Datacenter/ISP; the location field is required.
productstring · enumrequired
Possible values:
Datacenter ProxyISP Proxylocationstringrequired
cyclestringrequired
quantityinteger· min: 1· default: 1optional
promo_codestring· nullableoptional
auto_renewalboolean· default: falseoptional
addonsobject · CreateOrderAddonRequest[]· nullableoptionalAdd-ons attached at purchase time, for example p0f_slots for DC or ISP
Show propertiesHide properties
Add-ons attached at purchase time, for example p0f_slots for DC or ISP
addon_keystringrequired
qtyinteger· min: 1required
PurchaseRequestResidentialStandardobjectPurchase for Standart Residential Proxy; location is not required; the cycle is fixed (lifetime).
Show propertiesHide properties
Purchase for Standart Residential Proxy; location is not required; the cycle is fixed (lifetime).
productstring · enumrequired
Possible values:
Standart Residential Proxyquantityinteger· min: 1· default: 1optional
promo_codestring· nullableoptional
addonsobject · CreateOrderAddonRequest[]· nullableoptionalAdd-ons attached at purchase time, for example p0f_slots for DC or ISP
Show propertiesHide properties
Add-ons attached at purchase time, for example p0f_slots for DC or ISP
addon_keystringrequired
qtyinteger· min: 1required
objectPurchase for Premium Residential Proxy; location is not required; the cycle is fixed (lifetime).
Show propertiesHide properties
Purchase for Premium Residential Proxy; location is not required; the cycle is fixed (lifetime).
productstring · enumrequired
Possible values:
Premium Residential Proxyquantityinteger· min: 1· default: 1optional
promo_codestring· nullableoptional
addonsobject · CreateOrderAddonRequest[]· nullableoptionalAdd-ons attached at purchase time, for example p0f_slots for DC or ISP
Show propertiesHide properties
Add-ons attached at purchase time, for example p0f_slots for DC or ISP
addon_keystringrequired
qtyinteger· min: 1required
PurchaseRequestResidentialUnmeteredobjectPurchase for Unmetered Residential proxy; supports auto-renewal.
Show propertiesHide properties
Purchase for Unmetered Residential proxy; supports auto-renewal.
productstring · enumrequired
Possible values:
Unmetered Residential proxycyclestringrequired
promo_codestring· nullableoptional
auto_renewalboolean· default: falseoptional
addonsobject · CreateOrderAddonRequest[]· nullableoptionalAdd-ons attached at purchase time, for example p0f_slots for DC or ISP
Show propertiesHide properties
Add-ons attached at purchase time, for example p0f_slots for DC or ISP
addon_keystringrequired
qtyinteger· min: 1required
PurchaseRequestobjectShow propertiesHide properties
productstringrequired
locationstring· nullableoptional
cyclestringrequired
quantityinteger· min: 1· default: 1optional
promo_codestring· nullableoptional
auto_renewalboolean· default: falseoptional
addonsobject · CreateOrderAddonRequest[]· nullableoptionalAdd-ons attached at purchase time, for example p0f_slots for DC or ISP
Show propertiesHide properties
Add-ons attached at purchase time, for example p0f_slots for DC or ISP
addon_keystringrequired
qtyinteger· min: 1required
PurchaseResponseobjectShow propertiesHide properties
successbooleanrequired
messagestringrequired
order_idintegerrequired
ProductWithCyclesobjectShow propertiesHide properties
namestringrequired
descriptionstring· nullableoptional
locationstring· nullableoptional
cyclesstring[]required
AvailableCountResponseobjectShow propertiesHide properties
countrystringrequired
productstringrequired
amountintegerrequired
ApiMeResponseobjectShow propertiesHide properties
emailstringrequired
active_ordersintegerrequired
wallet_balanceintegerrequired
in cents
ApiSuccessobjectShow propertiesHide properties
successbooleanrequired
AvailableCountRequestobjectShow propertiesHide properties
countrystringrequired
productstringrequired
AddBandwidthRequestobjectShow propertiesHide properties
amountintegerrequired
Amount in GB
promo_codestring· nullableoptional
GetSubUsersRequestobjectShow propertiesHide properties
offsetintegeroptional
Offset (default 0)
limitintegeroptional
Page size (default 20)
EditSubUserPayloadobjectShow propertiesHide properties
namestringrequired
CreateSubUserPayloadobjectShow propertiesHide properties
proxy_typestringrequired
namestringrequired
dataintegerrequired
Amount in GB
ChangeSubUserPasswordPayloadobjectShow propertiesHide properties
proxy_typestringrequired
ModifyTrafficPayloadobjectShow propertiesHide properties
proxy_typestringrequired
dataintegerrequired
Amount in GB
CountryobjectShow propertiesHide properties
codestring· max length: 10required
ISO country code
namestring· max length: 255required
Country name
RegionobjectShow propertiesHide properties
codestring· max length: 10required
Region or state code
namestring· max length: 255required
Region or state name
countryobject · CountryrequiredShow propertiesHide properties
codestring· max length: 10required
ISO country code
namestring· max length: 255required
Country name
CityobjectShow propertiesHide properties
codestring· max length: 50required
City code, usually a slug
namestring· max length: 255required
City name
countryobject · CountryrequiredShow propertiesHide properties
codestring· max length: 10required
ISO country code
namestring· max length: 255required
Country name
regionobject· nullableoptionalShow propertiesHide properties
codestring· max length: 10required
Region code
namestring· max length: 255required
Region name
PagedCountriesResponseobjectShow propertiesHide properties
countintegerrequired
resultsobject · Country[]requiredShow propertiesHide properties
codestring· max length: 10required
ISO country code
namestring· max length: 255required
Country name
PagedRegionsResponseobjectShow propertiesHide properties
countintegerrequired
resultsobject · Region[]requiredShow propertiesHide properties
codestring· max length: 10required
Region or state code
namestring· max length: 255required
Region or state name
countryobject · CountryrequiredShow propertiesHide properties
codestring· max length: 10required
ISO country code
namestring· max length: 255required
Country name
PagedCitiesResponseobjectShow propertiesHide properties
countintegerrequired
resultsobject · City[]requiredShow propertiesHide properties
codestring· max length: 50required
City code, usually a slug
namestring· max length: 255required
City name
countryobject · CountryrequiredShow propertiesHide properties
codestring· max length: 10required
ISO country code
namestring· max length: 255required
Country name
regionobject· nullableoptionalShow propertiesHide properties
codestring· max length: 10required
Region code
namestring· max length: 255required
Region name
IspobjectShow propertiesHide properties
codestringrequired
ISP code, usually a slug
namestringrequired
ISP name
countryobject · CountryrequiredShow propertiesHide properties
codestring· max length: 10required
ISO country code
namestring· max length: 255required
Country name
regionobject· nullableoptionalShow propertiesHide properties
codestringrequired
Region code
namestringrequired
Region name
PagedIspsResponseobjectShow propertiesHide properties
countintegerrequired
resultsobject · Isp[]requiredShow propertiesHide properties
codestringrequired
ISP code, usually a slug
namestringrequired
ISP name
countryobject · CountryrequiredShow propertiesHide properties
codestring· max length: 10required
ISO country code
namestring· max length: 255required
Country name
regionobject· nullableoptionalShow propertiesHide properties
codestringrequired
Region code
namestringrequired
Region name
CreateOrderAddonRequestobjectShow propertiesHide properties
addon_keystringrequired
qtyinteger· min: 1required
Last updated on