> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter status de faturamento

> Retorna o estado de faturamento atual, modo de recurso e período de carência para o locatário autenticado.

```http theme={null}
GET /v1/billing/status
```

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

**status** `string`

O estado da conta de faturamento: `ACTIVE`, `PAST_DUE`, `UNPAID` ou `SUSPENDED`.

**feature\_mode** `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

**grace\_until** `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.

**banner** `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.

```javascript theme={null}
const res = await fetch("https://api.truthlocks.com/v1/billing/status", {
  headers: { "X-API-Key": "tl_live_..." },
});
const { feature_mode, grace_until } = await res.json();

if (feature_mode !== "NORMAL") {
  showPaymentBanner(feature_mode, grace_until);
}
```

## Tempo de período de carência

As janelas de carência padrão para o modo de contrato Padrão são:

| Transição | Janela de carência | Notificações |
| :- | :- | :- |
| NORMAL → DEGRADADO | 7 dias | Lembretes em T+24h, T+48h, T+72h |
| DEGRADADO → RESTRITO | 14 dias | Lembretes em T+24h, T+48h, T+72h |
| RESTRITO → SUSPENSO | Imediato | Aviso final de suspensã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](https://docs.truthlocks.com/pt/billing/overview.md#contract-modes) para detalhes.

> [!TIP]
>
> Consulte [falhas de pagamento e períodos de carência](https://docs.truthlocks.com/pt/billing/overview.md#payment-failures-and-grace-periods) para uma análise completa do fluxo de trabalho de acesso gradual.


## OpenAPI

````yaml pt/mint-openapi.yaml GET /v1/billing/status
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >-
    Truthlocks é uma infraestrutura de verificação universal para documentos,
    credenciais e ativos digitais.

    Esta especificação define a API canônica para interagir com os serviços
    Truthlocks.


    ## URLs Base

    - **Produção**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Autenticação

    - **Chaves de API**: Use o cabeçalho `X-API-Key` para operações máquina a
    máquina

    - **Tokens de Portador**: Use `Authorization: Bearer <jwt>` para operações
    iniciadas pelo usuário


    ## Identidade do Inquilino

    Em produção, a identidade do inquilino é derivada do contexto autenticado
    (chave de API ou JWT).

    O cabeçalho `X-Tenant-ID` é ignorado em produção para evitar falsificação.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de Produção
  - url: https://sandbox-api.truthlocks.com
    description: Ambiente Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gerenciamento de chaves e tokens de API
  - name: Issuers
    description: Registro do emissor e gerenciamento de confiança
  - name: Keys
    description: Gerenciamento de chaves criptográficas para emissores
  - name: Attestations
    description: Ciclo de vida da atestação (cunhar, revogar, substituir)
  - name: Verification
    description: Verificação de atestado e pacotes de prova
  - name: Governance
    description: Fluxos de trabalho de governança do emissor (somente administrador)
  - name: Identity
    description: Gerenciamento de organização, usuário e função
  - name: Audit
    description: Consultas de eventos de auditoria
  - name: Tenant Console
    description: Endpoints de perfil e ciclo de vida do locatário
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Risk
    description: Ingestão de sinal de risco e detecção de fraude
  - name: Risk Enforcement
    description: Ações de aplicação de risco — bloqueio, desafio, quarentena e configuração
  - name: Billing
    description: Gerenciamento de faturamento, assinatura e complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidade de Agente de Máquina (MAIP) — registro de agente,
      sessões, confiança, testemunha, conformidade, orquestração e
      observabilidade
externalDocs:
  description: API somente leitura de transparência (especificação de serviço separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/billing/status:
    get:
      tags:
        - Billing
      summary: Obter status de faturamento
      description: >-
        Retorna o status de faturamento, plano atual e sinalizadores de recursos
        para o locatário autenticado.
      operationId: billing.status
      responses:
        '200':
          description: Status do faturamento
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: string
                  status:
                    type: string
                  trial_ends_at:
                    nullable: true
                    type: string
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Código de erro legível por máquina
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Mensagem de erro legível por humanos
        http_status:
          type: integer
          description: Código de status HTTP
        retry_after_ms:
          type: integer
          description: >-
            Milissegundos para aguardar antes de tentar novamente (para limites
            de taxa)
        details:
          type: object
          description: Contexto de erro adicional
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de API para autenticação máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operações iniciadas pelo usuário

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.