Auto-extend by order IDs

Endpoint:

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

Toggles auto-renewal for whole orders — every IP in the specified orders will be automatically extended by rentPeriodDays before they expire. To toggle auto-extend on specific IPs instead, use Auto-extend by IP addresses.

Name	Type	Description
apiKey*	String	Your personal API key.

Request body

Name	Type	Description
proxyType*	string	One of: `IPv4`, `IPv6`, `MOBILE`, `ISP`.
orderIds*	array	Order IDs to toggle auto-extend on. All IPs in each order will be affected. Get them from Get IP addresses — the `orderId` field.
rentPeriodDays*	number	Extension duration in days for each automatic renewal. Get valid values from Rent period.
autoExtend*	boolean	`true` to enable auto-extend, `false` to disable.

Example

Same shape for all proxy types. Switch tabs to see each scenario.

{
      "success": true,
      "proxyType": "IPv4",
      "rentPeriodDays": 30,
      "quantity": 1,
      "orderIds": ["1112223334283d122"],
      "balance": 5,
      "currency": "USD",
      "error": null
    }

{
      "success": false,
      "proxyType": null,
      "rentPeriodDays": 0,
      "quantity": 0,
      "orderIds": [],
      "balance": 5,
      "currency": "USD",
      "error": {
        "code": 4,
        "message": "Incorrect proxy type"
      }
    }

Response fields

Field	Type	Description
`success`	boolean	`true` on success, `false` if `error` is populated.
`proxyType`	string \| null	Echoes the requested type. `null` on error.
`rentPeriodDays`	number	Echoes the requested period. `0` on error.
`quantity`	number	Number of IPs the change was applied to. `0` on error.
`ipAddressIds`	array	Echoes the requested IDs. Empty array on error.
`balance`	number	Account balance in `currency`.
`currency`	string	ISO currency code (e.g. `USD`).
`error`	object \| null	`{ code, message }` on failure. See Possible errors for codes.

The HTTP status is 200 OK for both success and error responses — check success: false to detect failures, not the HTTP code.

Auto-extend by order IDs

Endpoint:

Request body

Example

Response fields

On this page