Extend by orders ID

Price for IPv4 type

The request allows to calculate the price before extending by order IDs using all IP addresses from orders — for proxy type IPv4.

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

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).
orderIds*	List	Order IDs to extend (can be obtained by another request with ip addresses). All IP addresses from orders will be extended.
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": 0.80,
    "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": 0.80,
    "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": 0.80,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "NO_VALID",
    "error": null,
    "warnings": null
}

200: OK Error response

{
    "success": false,
    "proxyType": null,
    "balance": null,
    "price": null,
    "currency": null,
    "discount": null,
    "promoCodeStatus": null,
    "error": {
        "code": 29,
        "message": "Incorrect orderIds"
    },
    "warnings": null
}

Price for IPv6 type

The request allows to calculate the price before extending by order IDs using all IP addresses from orders — for proxy type IPv6.

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

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).
orderIds*	List	Order IDs to extend (can be obtained by another request with ip addresses). All IP addresses from orders will be extended.
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": 0.80,
    "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": 0.80,
    "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": 0.80,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "NO_VALID",
    "error": null,
    "warnings": null
}

200: OK Error response

{
    "success": false,
    "proxyType": null,
    "balance": null,
    "price": null,
    "currency": null,
    "discount": null,
    "promoCodeStatus": null,
    "error": {
        "code": 29,
        "message": "Incorrect orderIds"
    },
    "warnings": null
}

Price for mobile type

The request allows to calculate the price before extending by order IDs using all IP addresses from orders — for proxy type mobile.

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

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).
orderIds*	List	Order IDs to extend (can be obtained by another request with ip addresses). All IP addresses from orders will be extended.
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": 0.80,
    "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": 0.80,
    "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": 0.80,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "NO_VALID",
    "error": null,
    "warnings": null
}

200: OK Error response

{
    "success": false,
    "proxyType": null,
    "balance": null,
    "price": null,
    "currency": null,
    "discount": null,
    "promoCodeStatus": null,
    "error": {
        "code": 29,
        "message": "Incorrect orderIds"
    },
    "warnings": null
}

Price for ISP type

The request allows to calculate the price before extending by order IDs using all IP addresses from orders — for proxy type ISP.

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

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).
orderIds*	List	Order IDs to extend (can be obtained by another request with ip addresses). All IP addresses from orders will be extended.
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": 0.80,
    "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": 0.80,
    "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": 0.80,
    "currency": "USD",
    "discount": 0,
    "promoCodeStatus": "NO_VALID",
    "error": null,
    "warnings": null
}

200: OK Error response

{
    "success": false,
    "proxyType": null,
    "balance": null,
    "price": null,
    "currency": null,
    "discount": null,
    "promoCodeStatus": null,
    "error": {
        "code": 29,
        "message": "Incorrect orderIds"
    },
    "warnings": null
}