Authentication
Send an API key as a bearer token. The endpoint checks sites.view; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/seo/quota/top-up \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "quantity": <integer> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Buys a pack of additional lookups, paid from the account credit balance. Purchased lookups do not expire and are spent only once the daily plan allowance is used up. Idempotent on the Idempotency-Key header: repeating a request with the same key returns the same purchase rather than buying a second pack. 422 when the pack size is not sold or the credit balance does not cover it — in which case nothing is charged at all.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
Idempotency-Key (header) | string | No | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
quantity | integer | Yes | The pack size to buy. Must be one offered by GET /v1/seo/quota. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
daily_allowance | integer | Yes | Lookups included per day. -1 means unlimited. |
used_today | integer | Yes | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | No | — |
top_up_remaining | integer | No | Purchased lookups still unspent. These do not expire. |
remaining | integer | Yes | — |
is_unlimited | boolean | No | — |
can_look_up | boolean | Yes | Whether a lookup would be permitted right now. Not the same as remaining > 0: a suspended or unpaid account may have lookups left and still be refused. |
in_good_standing | boolean | No | — |
packs | object[] | Yes | Packs of extra lookups available to buy. |
Errors this endpoint can return
401 · 403 · 422