Youproxy

Rent period

Updated:

Returns valid rental durations (in days) for a given proxy type. Use the returned values when calling Create an order to set the rental length.

Endpoint:

GET/client/api/v1/{apiKey}/rentPeriod

Path parameters

Name

Type

Description

apiKey*

String

Your personal API key.

Query parameters

Name

Type

Description

proxyType*

String

Which proxy type to list countries for. Country availability differs by type: IPv4, IPv6, MOBILE, ISP

Examples

GET/client/api/v1/$KEY/rentPeriod?proxyType=IPv4
GET/client/api/v1/$KEY/rentPeriod?proxyType=IPv4
GET/client/api/v1/$KEY/rentPeriod?proxyType=MOBILE
GET/client/api/v1/$KEY/rentPeriod?proxyType=ISP

Response

{
    "success": true,
    "rentPeriodDays": [
        30,
        60,
        90,
        180,
        360
    ],
    "error": null
}

Name

Listed data

rentPeriodDays

30,
60,
90,
180,
360/tab

{
    "success": false,
    "countries": [],
    "error": {
        "code": 4,
        "message": "Incorrect proxy type"
    }
}

On this page