Youproxy
  • Welcome
  • How to start
    • Authorization
    • Custom settings
    • Preparations to create an order
    • Extend
    • Possible mistakes
  • API reference
    • Proxy type
    • Balance
    • Country
    • Rent period
    • Mobile operator
    • Promo codes
    • Price calculation
      • Calculate an order
      • Extend by IPs
      • Extend by orders ID
    • Create an order
    • Extend
      • Extend by IP addresses
      • Extend by order IDs
    • Auto-extend
      • Auto-extend by IP addresses
      • Auto-extend by order IDs
    • Get IP addresses
      • Get all
      • Get all by proxy type
      • Get page of all by proxy type
    • Possible errors
Powered by GitBook
On this page
  • IPv4 extension pricing
  • Path parameters
  • Request body
  • Response
  • IPv6 extension pricing
  • Path parameters
  • Request body
  • Response
  • Mobile extension pricing
  • Path parameters
  • Request body
  • Response
  • ISP extension pricing
  • Path parameters
  • Request body
  • Response
  1. API reference
  2. Price calculation

Extend by IPs

IPv4 extension pricing

The request allows to calculate the price before extending IP addresses for proxy type IPv4.

POST /client/api/v1/{apiKey}/calculate/extend

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Request body

Name
Type
Description

proxyType*

String

Proxy type IPv4.

promoCode

String

Code of the promo code (can be obtained by another request).

IpAddressIds*

List

IP addresses' IDs to extend (can be obtained by another request).

rentPeriodDays*

Number

Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response
{
    "success": true,
    "proxyType": "IPv4",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": null,
    "error": null,
    "warnings": null
}
200: OK Success response with warnings

If there're warnings, the order with current data won't be executed.

{
    "success": true,
    "proxyType": "IPv4",
    "balance": 7.18,
    "price": 8.30,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": null,
    "error": null,
    "warnings": [
        {
            "code": 16,
            "message": "Insufficient funds on balance"
        }
    ]
}

200: OK Success response with valid promo code
{
    "success": true,
    "proxyType": "IPv4",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "VALID",
    "error": null,
    "warnings": null
}
200: OK Success response with invalid promo code
{
    "success": true,
    "proxyType": "IPv4",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "NO_VALID",
    "error": null,
    "warnings": null
}

200: OK Error response
{
    "success": false,
    "proxyType": null,
    "balance": 0.65,
    "price": null,
    "currency": "USD",
    "discount": null,
    "promoCodeStatus": null,
    "error": {
        "code": 24,
        "message": "Incorrect ip addresses"
    },
    "warnings": null
}

IPv6 extension pricing

The request allows to calculate the price before extending IP addresses for proxy type IPv6.

POST /client/api/v1/{apiKey}/calculate/extend

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Request body

Name
Type
Description

proxyType*

String

Proxy type IPv6.

promoCode

String

Code of the promo code (can be obtained by another request).

IpAddressIds*

String

IP addresses' IDs to extend (can be obtained by another request).

All ip addresses from the order must be extended immediately.

rentPeriodDays*

Number

Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response
{
    "success": true,
    "proxyType": "IPv6",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": null,
    "error": null,
    "warnings": null
}
200: OK Success response with warnings

If there're warnings, the order with current data won't be executed.

{
    "success": true,
    "proxyType": "IPv6",
    "balance": 7.18,
    "price": 8.30,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": null,
    "error": null,
    "warnings": [
        {
            "code": 16,
            "message": "Insufficient funds on balance"
        }
    ]
}
200: OK Success response with valid promo code
{
    "success": true,
    "proxyType": "IPv6",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "VALID",
    "error": null,
    "warnings": null
}
200: OK Success response with invalid promo code
{
    "success": true,
    "proxyType": "IPv6",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "NO_VALID",
    "error": null,
    "warnings": null
}

200: OK Error response
{
    "success": false,
    "proxyType": null,
    "balance": 0.65,
    "price": null,
    "currency": "USD",
    "discount": null,
    "promoCodeStatus": null,
    "error": {
        "code": 24,
        "message": "Incorrect ip addresses"
    },
    "warnings": null
}

Mobile extension pricing

The request allows to calculate the price before extending IP addresses for proxy type MOBILE.

POST /client/api/v1/{apiKey}/calculate/extend

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Request body

Name
Type
Description

proxyType*

String

Proxy type MOBILE.

promoCode

String

Code of the promo code (can be obtained by another request).

IpAddressIds*

List

IP addresses' IDs to extend (can be obtained by another request).

rentPeriodDays*

Number

Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response
{
    "success": true,
    "proxyType": "MOBILE",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": null,
    "error": null,
    "warnings": null
}
200: OK Success response with warnings

If there're warnings, the order with current data won't be executed.

{
    "success": true,
    "proxyType": "MOBILE",
    "balance": 7.18,
    "price": 8.30,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": null,
    "error": null,
    "warnings": [
        {
            "code": 16,
            "message": "Insufficient funds on balance"
        }
    ]
}
200: OK Success response with valid promo code
{
    "success": true,
    "proxyType": "MOBILE",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "VALID",
    "error": null,
    "warnings": null
}
200: OK Success response with invalid promo code
{
    "success": true,
    "proxyType": "MOBILE",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "NO_VALID",
    "error": null,
    "warnings": null
}
200: OK Error response
{
    "success": false,
    "proxyType": null,
    "balance": 0.65,
    "price": null,
    "currency": "USD",
    "discount": null,
    "promoCodeStatus": null,
    "error": {
        "code": 24,
        "message": "Incorrect ip addresses"
    },
    "warnings": null
}

ISP extension pricing

The request allows to calculate the price before extending IP addresses for proxy type ISP.

POST /client/api/v1/{apiKey}/calculate/extend

Path parameters

Name
Type
Description

apiKey*

String

Your personal API key.

Request body

Name
Type
Description

proxyType*

String

Proxy type ISP.

promoCode

String

Code of the promo code (can be obtained by another request).

IpAddressIds*

List

IP addresses' IDs to extend (can be obtained by another request).

rentPeriodDays*

Number

Number of days in the rental period (can be obtained by another request).

Response

200: OK Success response
{
    "success": true,
    "proxyType": "ISP",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": null,
    "error": null,
    "warnings": null
}
200: OK Success response with warnings

If there're warnings, the order with current data won't be executed.

{
    "success": true,
    "proxyType": "ISP",
    "balance": 7.18,
    "price": 8.30,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": null,
    "error": null,
    "warnings": [
        {
            "code": 16,
            "message": "Insufficient funds on balance"
        }
    ]
}
200: OK Success response with valid promo code
{
    "success": true,
    "proxyType": "ISP",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "VALID",
    "error": null,
    "warnings": null
}
200: OK Success response with invalid promo code
{
    "success": true,
    "proxyType": "ISP",
    "balance": 7.18,
    "price": 2.65,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "NO_VALID",
    "error": null,
    "warnings": null
}
200: OK Error response
{
    "success": false,
    "proxyType": null,
    "balance": 0.65,
    "price": null,
    "currency": "USD",
    "discount": null,
    "promoCodeStatus": null,
    "error": {
        "code": 24,
        "message": "Incorrect ip addresses"
    },
    "warnings": null
}
PreviousCalculate an orderNextExtend by orders ID

Last updated 1 month ago