Consulta de Saldo de Créditos

Retorna o plano atual, o saldo de créditos restantes e o status de faturamento da sua conta. Consulta somente leitura — nunca consome crédito.

Endpoint

GEThttps://api.cpfhub.io/quota

Autenticação

Envie sua API Key no header x-api-key. Veja Autenticação.

Parâmetros

Este endpoint não recebe parâmetros de path ou query.

Headers

Header	Obrigatório	Descrição
`x-api-key`	Sim	Sua API Key do CPFHub.io

Exemplos de requisição

curl --request GET \
--url https://api.cpfhub.io/quota \
--header 'x-api-key: SUA_API_KEY'

Resposta de sucesso

HTTP 200 OK

JSON

{
  "success": true,
  "data": {
    "plan": "Customizado",
    "remainingCredits": 49,
    "billingStatus": "active",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "email": "usuario@exemplo.com"
  }
}

Campos da resposta

Campo	Tipo	Descrição
`success`	`boolean`	`true` se a requisição foi processada com sucesso
`data.plan`	`string`	Plano atualmente associado à conta
`data.remainingCredits`	`number`	Quantidade de créditos disponíveis para novas consultas
`data.billingStatus`	`"active"` \| `"free"`	Status atual de faturamento da conta
`data.userId`	`string`	Identificador único do usuário
`data.email`	`string`	Endereço de e-mail associado à conta

✦

Funciona mesmo com créditos esgotados

Diferente dos demais endpoints, GET /quota não é bloqueado quando o saldo de créditos chega a zero — assim você sempre consegue consultar seu saldo programaticamente e evitar interrupções inesperadas nas consultas.

Códigos de status

Status	Descrição
`200 OK`	Consulta de saldo bem-sucedida
`401 Unauthorized`	API Key ausente ou inválida
`403 Forbidden`	Conta de usuário inativa (não ocorre por falta de créditos)
`500 Internal Server Error`	Erro interno ao validar a assinatura

⚠

Mantenha sua API Key em segurança

Nunca exponha sua API Key em código público, repositórios ou aplicações executadas diretamente no navegador. Realize as chamadas à API sempre a partir do seu backend ou servidor.

Para a lista completa de códigos de erro e mensagens, veja Códigos de Erro.

Atualizado em 7 de julho de 2026