Auto-upgrade

Auto-upgrade is on for every paid subscription unless you switch it off. When your daily look-ups run out and the monthly buffer behind them is used up too, the subscription moves up one plan and the difference is charged to its card straight away, so look-ups keep working. It moves one plan at a time, and at most once an hour.

Switched off, look-ups are refused with 429 at the limit until your allowance resets. Auto-upgrade is not available on the Free plan, and a subscription on our largest plan has nowhere to move to.

Requires your administration key — the subscription changed is the one the key belongs to. You can also switch it on the Billing tab of your console.

Request

PUT https://api.getaddress.io/subscription/auto-upgrade?api-key={your-admin-key}    

Body

{
    "enabled": false
}

Response

{
    "name": "500-per-day",
    "enabled": false
}

A body without enabled, or an admin key for a Free subscription, is refused with 400. The API key used for address look-ups is refused with 403.