The organisation's plan, its limits and this month's usage.
const url = 'https://api.opdns.io/v1/account/plan';const options = { method: 'GET', headers: {cookie: '__Host-opdns_session=<__Host-opdns_session>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.opdns.io/v1/account/plan \ --cookie __Host-opdns_session=<__Host-opdns_session>Token scope: account:read. Plans attach to the organisation. limits
are the plan’s ceilings, usage what the organisation holds of the counted ones
(linked_ips is the most any one profile holds), and queries the billable
queries of the calendar month (UTC): every query the cloud resolved for its
profiles, logged or counted, never one a self-hosted node resolved. queries.used
is metered from the query counters at most a few minutes behind (null before the
first metering); queries.state is what the resolvers apply: warn from 80 %,
over at the limit, when the resolvers keep resolving and filtering but stop
keeping query logs until reset_at or a larger plan. Profiles, linked addresses,
nodes, retention and API tokens past a limit are refused with 422 plan_limit;
requests with an API token past api_requests_per_minute (per organisation) get
429 rate_limited. provisional is true while the plan’s price or limits may
still change before paid plans start. upgrade is the plan the organisation is
offered next (its name, list price and limits, for upgrade prompts), null when
there is none.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”The plan.
object
Who set the plan last.
The plan’s price or limits may still change before paid plans start.
object
Whole currency units a month; null when priced on request.
Whole currency units a year; null when priced on request.
A plan’s ceilings.
object
Live profiles per organisation.
Linked addresses and DDNS slots per profile.
Self-hosted nodes per organisation (enrolled, or pending with a valid code).
Billable queries per calendar month (UTC). Metered, never refused.
The longest log retention a profile may choose.
Unexpired API tokens per organisation.
Requests a minute with an API token, per organisation (429 past it).
object
The most linked addresses and slots any one profile holds.
object
Billable queries so far this month; null before the first metering.
Used / limit.
What the resolvers apply; over pauses query logs, never resolution or filtering.
The share of the limit from which the state is warn (0.8).
The calendar month (UTC), YYYY-MM.
When usage starts again from zero (the next month, 00:00 UTC).
A plan on offer, with its list price (whole currency units) and limits.
object
object
Whole currency units a month; null when priced on request.
Whole currency units a year; null when priced on request.
A plan’s ceilings.
object
Live profiles per organisation.
Linked addresses and DDNS slots per profile.
Self-hosted nodes per organisation (enrolled, or pending with a valid code).
Billable queries per calendar month (UTC). Metered, never refused.
The longest log retention a profile may choose.
Unexpired API tokens per organisation.
Requests a minute with an API token, per organisation (429 past it).
Example
{ "plan": "free", "name": "Free", "source": "default", "changed_at": null, "provisional": true, "price": { "currency": "USD", "monthly": 0, "yearly": 0 }, "limits": { "profiles": 3, "linked_ips": 20, "nodes": 1, "queries_per_month": 300000, "log_retention_days": 30, "api_tokens": 2, "api_requests_per_minute": 120 }, "usage": { "profiles": 2, "linked_ips": 1, "nodes": 0, "api_tokens": 1 }, "queries": { "used": 182340, "limit": 300000, "ratio": 0.6078, "state": "ok", "warn_ratio": 0.8, "period": "2026-10", "period_start": "2026-10-01T00:00:00Z", "reset_at": "2026-11-01T00:00:00Z", "metered_at": "2026-10-20T12:00:00Z" }, "upgrade_url": "https://opdns.io/pricing/", "upgrade": { "plan": "personal", "name": "Personal", "price": { "currency": "USD", "monthly": 2, "yearly": 10 }, "limits": { "profiles": 10, "linked_ips": 20, "nodes": 3, "queries_per_month": 5000000, "log_retention_days": 90, "api_tokens": 10, "api_requests_per_minute": 300 } }}Not authenticated.
object
Stable machine code.
object
Seconds, repeating the Retry-After header (rate limits, offline nodes).
The plan limit a plan_limit problem hit.
object
The plan’s value of the limit.
Where to move to a larger plan.
The scope the API token lacked (insufficient_scope).
Example
{ "type": "https://opdns.io/problems/unauthenticated", "title": "Unauthorized", "status": 401, "code": "unauthenticated", "detail": "You're not signed in, or your sign-in has ended. Please sign in again to continue.", "request_id": "5f2c9a0e7b1d4c38"}Authenticated but not allowed: insufficient_scope, session_required, csrf_rejected, reauth_required (sign in again within five minutes), account_pending_deletion (the account is in its deletion cooling-off), email_unverified (creating a profile before the email address is verified).
object
Stable machine code.
object
Seconds, repeating the Retry-After header (rate limits, offline nodes).
The plan limit a plan_limit problem hit.
object
The plan’s value of the limit.
Where to move to a larger plan.
The scope the API token lacked (insufficient_scope).
Example
{ "type": "https://opdns.io/problems/insufficient_scope", "title": "Forbidden", "status": 403, "code": "insufficient_scope", "detail": "This API token isn't allowed to do this: it needs the profiles:write scope. Create a token that includes it, then try again.", "required_scope": "profiles:write", "request_id": "5f2c9a0e7b1d4c38"}