ARNPROXY

Enable existing automatic balance renewal; no immediate charge

POST/account/api/v1/auto-renewal/enable
Confirm the operation deliberately

This operation may change a record, balance or service configuration. Read its scope and notes first. After an uncertain result, query the same operation rather than starting another.

Authorization

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Required permissionrenewals
Acceptapplication/json
Content-Typeapplication/json
Idempotency-Key16–100 letters, digits, _ or -. Persist and reuse the same value for the same operation.

Parameters

NameTypeDescription
Idempotency-Key
headerRequired
string16–100 letters/digits/_/-. Keep the same value for the operation/status; do not reuse with a different body.
proxy_ids
bodyRequired
integer[]1–1000 unique owned proxy IDs; do not mix product types where a common scope/price is required. Some operations have tighter bounds.
time_id
bodyRequired
integerPeriod/GB-plan ID from the matching catalog/options, not a day/GB count.
expected_revision
bodyRequired
stringrevision from this operation’s scope/settings read: 64 lowercase hex characters.
currency
bodyRequired
stringTRY or USD from the same quote; must match the account currency.
expected_total_minor
bodyRequired
integertotal_minor from the same quote, as an integer; never decimal money or a string. 1–999999999999.
expected_days
bodyRequired
integerdays from the same price quote.
terms
bodyRequired
booleanMust be the JSON boolean true for explicit approval, not the string "true".
accept_current_pricing
bodyRequired
booleanMust be true; consents to future balance renewals at the then-current price.

Request body

Replace YOUR_/FROM_ placeholders with values from the relevant catalog, quote or scope. Examples leave consent false; only approve a real operation intentionally.

request.json
{
    "proxy_ids": [
        "YOUR_PROXY_ID"
    ],
    "time_id": "FROM_AUTO_RENEWAL_QUOTE",
    "expected_revision": "FROM_AUTO_RENEWAL_QUOTE_REVISION",
    "currency": "FROM_QUOTE",
    "expected_total_minor": "FROM_QUOTE_TOTAL_MINOR",
    "expected_days": "FROM_QUOTE_DAYS",
    "terms": false,
    "accept_current_pricing": false
}

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 \
    --header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/auto-renewal/enable'

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": {
        "state": "completed",
        "action": "enable",
        "proxy_ids": [
            12345
        ],
        "settings": [
            {
                "id": 20,
                "proxy_id": 12345,
                "order_number": null,
                "active": true,
                "payment_method": "balance",
                "time_id": 101,
                "currency": "TRY",
                "next_renewal_date": "2030-02-01",
                "next_attempt_at": null,
                "last_status": "waiting",
                "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                "managed_via_website": false,
                "timezone": "Europe/Istanbul"
            }
        ],
        "payment_method": "balance",
        "price_policy": "current_price_at_each_renewal",
        "current_estimate": "10.00",
        "currency": "TRY",
        "days": 7,
        "configuration_only": true,
        "immediate_charge": false,
        "balance_changed": false,
        "proxy_expiry_changed": false,
        "provider_requests": 0,
        "payment_requests": 0,
        "consent_version": "balance_current_pricing_v1",
        "api_key_revocation_stops_existing_renewals": false,
        "source": "existing_website_auto_renewal",
        "completed_at": "2030-01-01T12:00:00+00:00",
        "replayed": false
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Response fields and types
NameTypeDescription
okbooleanSuccess envelope flag; on false inspect error.code.
dataobjectOperation-specific result; examples are illustrative and synthetic.
data.statestringRecord/operation state. accepted is not delivery; completed is not a connection test.
data.actionstringOperation-specific action value; preserve its demonstrated type and consult the behavior notes.
data.proxy_idsarrayProxy IDs in the scope visible to this account.
data.proxy_ids[]integerProxy IDs in the scope visible to this account.
data.settingsarrayOperation-specific settings value; preserve its demonstrated type and consult the behavior notes.
data.settings[]objectOperation-specific settings value; preserve its demonstrated type and consult the behavior notes.
data.settings[].idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.settings[].proxy_idintegerRelevant ARNPROXY record ID; use it instead of the upstream internal ID.
data.settings[].order_numberstring|nullDisplay order number; not interchangeable with fields requesting an id.
data.settings[].activebooleanWhether the record is active; inactive historical settings may remain stored.
data.settings[].payment_methodstringBalance/card/PayPal method; API configuration management supports balance only.
data.settings[].time_idintegerLocal period/GB-plan record ID, not a day or GB count.
data.settings[].currencystringAccount transaction currency: TRY or USD.
data.settings[].next_renewal_datestringSaved renewal day or retry timestamp, not evidence that a debit has occurred.
data.settings[].next_attempt_atstring|nullSaved renewal day or retry timestamp, not evidence that a debit has occurred.
data.settings[].last_statusstringOperation-specific last status value; preserve its demonstrated type and consult the behavior notes.
data.settings[].revisionstringFreshness fingerprint to copy unchanged to the corresponding write/price confirmation.
data.settings[].managed_via_websitebooleanOperation-specific managed via website value; preserve its demonstrated type and consult the behavior notes.
data.settings[].timezonestringTimezone for related date fields; null means no verified timezone.
data.payment_methodstringBalance/card/PayPal method; API configuration management supports balance only.
data.price_policystringOperation-specific price policy value; preserve its demonstrated type and consult the behavior notes.
data.current_estimatestringMoney amount; preserve the returned string/integer representation for precision.
data.currencystringAccount transaction currency: TRY or USD.
data.daysintegerPlan duration in days, separate from a GB plan’s traffic amount.
data.configuration_onlybooleanOperation-specific configuration only value; preserve its demonstrated type and consult the behavior notes.
data.immediate_chargebooleanReported effect of this operation; an automatic-renewal setting can cause future separate debits.
data.balance_changedbooleanReported effect of this operation; an automatic-renewal setting can cause future separate debits.
data.proxy_expiry_changedbooleanReported effect of this operation; an automatic-renewal setting can cause future separate debits.
data.provider_requestsintegerOperation-specific provider requests value; preserve its demonstrated type and consult the behavior notes.
data.payment_requestsintegerOperation-specific payment requests value; preserve its demonstrated type and consult the behavior notes.
data.consent_versionstringOperation-specific consent version value; preserve its demonstrated type and consult the behavior notes.
data.api_key_revocation_stops_existing_renewalsbooleanfalse: revoking a key does not disable existing automatic renewal; disable the setting separately.
data.sourcestringData source; local records and a live provider lookup are different evidence.
data.completed_atstringTimestamp in the API’s returned representation; example dates are synthetic.
data.replayedbooleanSaved result for the same operation was returned, not proof of a new debit/action.
metaobjectRequest correlation and data-source metadata.
meta.request_idstringThis HTTP request’s correlation ID, not an operation key or order ID.
meta.phasestringOperation-specific phase value; preserve its demonstrated type and consult the behavior notes.
meta.sourcestringData 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

  • These resources only configure existing balance renewal; they do not charge or extend now. The existing cron later renews from balance at the then-current price. Revoking an API key does not disable saved renewal settings; disable them separately. Card/PayPal settings remain website-managed. No promo applies; country-based quantity discounts and full IPv6-order selection remain. Disabling cannot undo started/completed renewals.
  • A timeout/5xx is not proof that a write failed. Use the original Idempotency-Key with its status resource. Do not retry under a new key; GET does not resend the change.
Follow the same operationRead the saved result of a settings operation; never reapply →

Search the current language. Close with Esc