Saltar para o conteúdo principal
GET
Obter status de faturamento
Retorna a saúde de faturamento atual do seu locatário. Use este endpoint em sua integração para detectar problemas de pagamento precocemente e exibir avisos aos seus usuários antes que o acesso seja restrito. Quando todos os pagamentos estão em dia, feature_mode é NORMAL e grace_until é null. Se um pagamento falhar, a conta entra em um fluxo de trabalho de acesso gradual — Degradado, Restrito, depois Suspenso — com um período de carência em cada etapa.

Resposta

string
O estado da conta de faturamento: ACTIVE, PAST_DUE, UNPAID ou SUSPENDED.
string
O nível atual de capacidade de recursos:
  • NORMAL — todos os recursos disponíveis
  • DEGRADED — pagamento falhou; todos os recursos ainda funcionam durante o período de carência
  • RESTRICTED — período de carência acabando; operações de escrita (cunhagem, criação de chave) estão desativadas
  • SUSPENDED — período de carência expirado; todo o acesso à API está desativado até que o pagamento seja resolvido
string | null
Carimbo de data/hora ISO 8601 para quando o período de carência atual termina, ou null se a conta estiver em situação regular.
string | null
Uma mensagem legível descrevendo a ação necessária, ou null quando nenhuma ação é necessária.

Quando usar este endpoint

Use GET /v1/billing/status para:
  • Exibir avisos de pagamento — verifique feature_mode na inicialização do aplicativo ou no login e mostre um banner quando o valor for diferente de NORMAL.
  • Proteger operações de escrita — antes de cunhar ou criar chaves, verifique se feature_mode não é RESTRICTED ou SUSPENDED.
  • Acompanhar prazos de carência — leia grace_until para mostrar aos seus usuários exatamente quanto tempo eles têm para resolver um problema de pagamento.

Tempo de período de carência

As janelas de carência padrão para o modo de contrato Padrão são: Contratos empresariais adicionam 14 dias extras a cada janela. Contratos governamentais usam um período de carência fixo de 90 dias sem suspensão automática. Consulte modos de contrato para detalhes.
Consulte falhas de pagamento e períodos de carência para uma análise completa do fluxo de trabalho de acesso gradual.

Autorizações

X-API-Key
string
header
obrigatório

Chave de API para autenticação máquina a máquina

Resposta

Status do faturamento

plan
string
status
string
trial_ends_at
string | null