Consultar sua cota

O que este endpoint responde

Uma chamada informa a situação do mês: quantas páginas o plano inclui, quantas foram usadas e se o excedente é permitido. Serve para seu próprio painel e para a verificação antes de uma tarefa em lote.

Consulta sua cota mensal, consumo e estado de excedentes, para mostrar no seu próprio painel.

Solicitação

curl https://api.pdfgine.com/api/v1/usage \
  -H "X-PDFgine-Key: $PDFGINE_KEY"

Resposta

{
  "organizationName": "Northwind Trading Ltd.",
  "planCode": "business",
  "monthlyPageQuota": 5000,
  "usedPages": 1284,
  "quotaRemaining": 3716,
  "monthlyPreviewPageAllowance": 250,
  "usedPreviewPages": 32,
  "allowsOverage": true,
  "monthlyOverageCap": 1000,
  "overagePages": 0,
  "meteringBasis": "pdf-equivalent"
}

Campo a campo

Todas as contagens se referem ao mês de cobrança atual e reiniciam na virada do período.

Campo	O que significa
`monthlyPageQuota`	Páginas incluídas no plano neste mês.
`usedPages`	Páginas produzidas até agora neste mês.
`quotaRemaining`	monthlyPageQuota menos usedPages no momento desta resposta.
`monthlyPreviewPageAllowance`	Páginas de prévia incluídas além da cota de páginas; uma prévia não consome a cota de produção.
`allowsOverage`	Se as renderizações continuam quando a cota acaba. Quando false, a próxima renderização responde 402.
`monthlyOverageCap`	Quanto as renderizações podem exceder a cota quando o excedente é permitido.
`meteringBasis`	O que uma página significa para o faturamento. pdf-equivalent conta uma saída docx ou html com a mesma quantidade de páginas que o PDF teria.

Pessoas e empresas subsidiárias

O plano inclui mais dois limites contados por organização: quantas pessoas podem estar no espaço de trabalho e quantas empresas subsidiárias ele pode gerenciar.

Plano	Pessoas	Empresas subsidiárias
Grátis	2	0
Go	3	0
Pro	10	5
Max	Ilimitado	Ilimitado

Um convite que excede o limite de membros é recusado no envio, não na aceitação, para que ninguém perca tempo com um convite que nunca funcionaria.

Os problemas mais comuns

Não chame este endpoint após cada renderização. Cada renderização já retorna X-PDFgine-Quota-Remaining, o mesmo número sem uma segunda chamada.
Prévias e renderizações de produção são contadas separadamente. Uma prévia que não alterou usedPages não falhou; ela alterou usedPreviewPages.
allowsOverage false com a cota esgotada significa 402 na próxima renderização, não uma fila mais lenta. Monitore quotaRemaining, não o erro.
Cota e limite de requisições são limites diferentes. Uma chave pode chamar 120 vezes a cada 60 segundos, independentemente da cota restante; acima disso, a resposta é 429 com Retry-After.
Os contadores seguem o mês de cobrança, não o mês do calendário. Em um plano comprado no dia 12, o período renova no dia 12.