Renewable proxies and periods

GET/account/api/v1/renewals/options

Authorization

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
Required permission	`read`
Accept	`application/json`

Parameters

Name	Type	Description
`after_id` queryOptional	`integer`	Use next_after_id from the previous response; ascending-ID cursor, starting at 0. Default: `0`
`limit` queryOptional	`integer`	1–100; default 25. Default: `25`

Request example

cURL

printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    'https://www.arnproxy.com/account/api/v1/renewals/options'

Examples are not executed on this page. Keep the API key in a server-side environment variable; do not put real keys in URLs or browser code. Prepare request.json for POST examples.

Responses

200Success response

application/json

{
    "ok": true,
    "data": {
        "items": [
            {
                "id": 12345,
                "endpoint": "192.0.2.10:8080",
                "order_id": 10001,
                "product": {
                    "id": 5,
                    "name": "IPv4 Proxy"
                },
                "location": {
                    "id": 10,
                    "name": "Example country"
                },
                "last_service_date": "2030-02-01"
            }
        ],
        "next_after_id": null,
        "periods_by_location": [
            {
                "location_id": 10,
                "periods": [
                    {
                        "id": 101,
                        "name": "7 days",
                        "days": 7
                    }
                ]
            }
        ],
        "currency": "TRY",
        "timezone": "Europe/Istanbul",
        "max_selected_proxies": 1000,
        "renewal_available": true
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

Response fields and types

Name	Type	Description
`ok`	`boolean`	Success envelope flag; on false inspect error.code.
`data`	`object`	Operation-specific result; examples are illustrative and synthetic.
`data.items`	`array`	Records on this page or formatted connection strings; an empty list can be valid.
`data.items[]`	`object`	Records on this page or formatted connection strings; an empty list can be valid.
`data.items[].id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.items[].endpoint`	`string`	Proxy IP/host and optional port, without credentials; unverified formatting can produce null.
`data.items[].order_id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.items[].product`	`object`	Operation-specific product value; preserve its demonstrated type and consult the behavior notes.
`data.items[].product.id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.items[].product.name`	`string`	Operation-specific name value; preserve its demonstrated type and consult the behavior notes.
`data.items[].location`	`object`	Operation-specific location value; preserve its demonstrated type and consult the behavior notes.
`data.items[].location.id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.items[].location.name`	`string`	Operation-specific name value; preserve its demonstrated type and consult the behavior notes.
`data.items[].last_service_date`	`string`	Last service day: current, previous or projected by the quote. A projection does not renew.
`data.next_after_id`	`integer\|null`	Cursor for the next page; null means no further page in this result.
`data.periods_by_location`	`array`	Operation-specific periods by location value; preserve its demonstrated type and consult the behavior notes.
`data.periods_by_location[]`	`object`	Operation-specific periods by location value; preserve its demonstrated type and consult the behavior notes.
`data.periods_by_location[].location_id`	`integer`	Local catalog location or product-type ID.
`data.periods_by_location[].periods`	`array`	Operation-specific periods value; preserve its demonstrated type and consult the behavior notes.
`data.periods_by_location[].periods[]`	`object`	Operation-specific periods value; preserve its demonstrated type and consult the behavior notes.
`data.periods_by_location[].periods[].id`	`integer`	Relevant ARNPROXY record ID; use it instead of the upstream internal ID.
`data.periods_by_location[].periods[].name`	`string`	Operation-specific name value; preserve its demonstrated type and consult the behavior notes.
`data.periods_by_location[].periods[].days`	`integer`	Plan duration in days, separate from a GB plan’s traffic amount.
`data.currency`	`string`	Account transaction currency: TRY or USD.
`data.timezone`	`string`	Timezone for related date fields; null means no verified timezone.
`data.max_selected_proxies`	`integer`	Operation-specific max selected proxies value; preserve its demonstrated type and consult the behavior notes.
`data.renewal_available`	`boolean`	Availability under the result’s conditions/permissions, not a stock or provider guarantee.
`meta`	`object`	Request correlation and data-source metadata.
`meta.request_id`	`string`	This HTTP request’s correlation ID, not an operation key or order ID.
`meta.phase`	`string`	Operation-specific phase value; preserve its demonstrated type and consult the behavior notes.
`meta.source`	`string`	Data source; local records and a live provider lookup are different evidence.

Error response

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Authentication and validation may reject a request before execution. Consult the error reference and retain request_id when contacting support. Never send keys or passwords. Errors & limits →

Behavior & important notes

Renewal uses existing website pricing and balance processing. Copy amount, days and selection hash from the same renewal_quote. It does not enable automatic renewal.