Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
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> }'Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
Idempotency-Key (header) | string | Não | Caller-supplied replay key. Strongly recommended: without one, a retried request buys a second pack. |
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
quantity | integer | Sim | The pack size to buy. Must be one offered by `GET /v1/seo/quota`. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
daily_allowance | integer | Sim | Lookups included per day. `-1` means unlimited. |
used_today | integer | Sim | Plan-funded lookups run since midnight UTC. |
plan_remaining | integer | Não | — |
top_up_remaining | integer | Não | Purchased lookups still unspent. These do not expire. |
remaining | integer | Sim | — |
is_unlimited | boolean | Não | — |
can_look_up | boolean | Sim | 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 | Não | — |
packs | object[] | Sim | Packs of extra lookups available to buy. |
Erros que este endpoint pode retornar
401 · 403 · 422