Calculate the order

This request helps you calculate the price of an order.

The proxy identifiers change after manual or automatic renewals

Endpoint:

POSThttps://proxy-seller.com/personal/api/v2/{YourApiKey}/order/calc

Path parameters

Name	Value	Description
Authorization	`<Your_API_Key>`	Your personal API key (how to get)

Request body

Name	Type	Description
countryId	String	ID of the country you selected in the /reference/list/{type}, for example “USA“
periodId	String	ID of the period you selected in the /reference/list/{type} request, for example “1m“
coupon	String	The coupon code, if available
paymentId	String	Id's of payments system “balance“ - balance, “card“ - card that you added in your cabinet
quantity	Number	The number of proxies you want to order
authorization	String	The method of authorization. Leave blank if you want to use username and password for authorization
customTargetName	String	Required to add a custom goal
sectionCode	String	Proxy type key, for example `ipv4`, `ipv6`, `mobile, mix, isp_mix`
uptime	boolean	Enables Uptime / High Availability mode for IPv4/ISP orders. Default: false. Available for IPv4 and ISP when the selected country and period support uptime pricing

Name	Type	Description
countryId	String	ID of the country you selected in the /reference/list/{type} request, for example “USA“
periodId	String	ID of the period you selected in the /reference/list/{type} request, for example “1m“
coupon	String	The coupon code, if available
paymentId	String	Id's of payments system “balance“ - balance, “card“ - card that you added in your cabinet
quantity	Number	The number of proxies you want to order
authorization	String	The method of authorization. Leave blank if you want to use username and password for authorization
customTargetName	String	Required to add a custom goal
protocol	String	HTTPS or SOCKS5
sectionCode	String	Proxy type key, for example `ipv4`, `ipv6`, `mobile, mix, isp_mix`

Name	Type	Description
countryId	String	ID of the country you selected in the /reference/list/{type} request, for example “USA“
periodId	String	ID of the period you selected in the /reference/list/{type} request, for example “1m“
coupon	String	The coupon code, if available
paymentId	String	Id's of payments system “balance“ - balance, “card“ - card that you added in your cabinet
quantity	Number	The number of proxies you want to order
authorization	String	The method of authorization. Leave blank if you want to use username and password for authorization
mobileServiceType	String	shared or dedicated
operatorId	String	Mobile operator ID from /reference/list/mobile request
rotationId	String	Mobile rotation value from /reference/list/mobile. Must be an integer value in minutes
sectionCode	String	Proxy type key, for example `ipv4`, `ipv6`, `mobile, mix, isp_mix`

Name	Type	Description
coupon	String	The coupon code, if available
paymentId	String	Id's of payments system “balance“ - balance, “card“ - card that you added in your cabinet
tarifId	Number	ID of the tarid you selected in the /reference/list/resident request

Example

https://proxy-seller.com/personal/api/v2/fj4948ffhg58gh843gh/order/calc
{
    "countryId": "USA",
    "periodId": "1m",
    "coupon": "",
    "paymentId": "balance",
    "quantity": 1,
    "authorization": "",
    "customTargetName": "Facebook",
    "sectionCode": "isp",
    "uptime": false
}

Response

{
    "status": "success",
    "data": {
        "warning": "",
        "balance": 2000,
        "total": 9,
        "quantity": 5,
        "currency": "USD",
        "discount": 0.45,
        "price": 1.8
    },
    "errors": []
}

don't have subscribed card

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Not subscribed. Add subscribe in personal area /personal/balance/",
            "code": 0,
            "customData": null
        }
    ]
}

wrong countryId

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Country not exists",
            "code": 0,
            "customData": null
        }
    ]
}

wrong periodId

{
    "status": "error",
    "data": null,
    "errors": [
        {
            "message": "Set existed [periodId] from reference",
            "code": 0,
            "customData": null
        }
    ]
}

Endpoint:

Path parameters

Request body

Example

Response

On this page