> ## 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.

# Uso aceito e faturas mensais

> Leia as classificações de uso aceitas do seu espaço de trabalho e os pagamentos de faturas mensais.

Requer autenticação e retorna apenas os registros do espaço de trabalho do chamador. Este endpoint não gera, aprova ou paga faturas.

`usage` contém até 500 registros agrupados. Leia `environment`, `classification`, `quantity`, `currency` e `amount_cents` juntos. `rated` significa que o snapshot de preços foi preservado na aceitação do faturamento. Sandbox, planos gratuitos, planos de consumidor, pilotos aprovados e novas tentativas de cunhagem históricas são excluídos das cobranças de uso comercial. Preços principais não resolvidos ou evidências de ambiente retêm o mês para revisão da equipe.

`settlements` contém até 200 registros de fatura mensais, os mais recentes primeiro. Uma `DRAFT` não é pagável. A equipe deve revisar o acordo comercial aceito, impostos e país de faturamento antes da emissão. `automatic_collection` é sempre `false` para este fluxo de trabalho: a emissão de uma fatura não cobra um método de pagamento salvo.

O mês de faturamento UTC usa o tempo de aceitação. Os contadores agregados existentes não são faturados retroativamente. Continue usando a mesma chave de idempotência de cunhagem se uma cunhagem relatar que seu recibo de faturamento não pôde ser confirmado.

Valores terminados em `_cents` são centavos inteiros. A fatura recuperada separadamente usa unidades monetárias. Por exemplo, `amount_cents: 2500` corresponde a USD 25,00.


## OpenAPI

````yaml pt/mint-openapi.yaml GET /v1/billing/usage-settlements
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/usage-settlements:
    get:
      tags:
        - Billing
      summary: Leia o uso aceito e os pagamentos de faturas mensais
      description: >-
        Retorna apenas o uso aceito do seu espaço de trabalho e os últimos
        pagamentos mensais. Não gera faturas nem cobra métodos de pagamento.
      operationId: billing.usageSettlements
      responses:
        '200':
          description: Uso aceito e liquidações
          content:
            application/json:
              schema:
                type: object
                properties:
                  settlements:
                    type: array
                    items:
                      type: object
                  usage:
                    type: array
                    items:
                      type: object
                  settlement_mode:
                    type: string
                    enum:
                      - draft_then_staff_review
                  automatic_collection:
                    type: boolean
                    enum:
                      - false
                  usage_limit:
                    type: integer
                    example: 500
                  settlement_limit:
                    type: integer
                    example: 200
        '401':
          description: Autenticação necessária
        '503':
          description: Registros de uso indisponíveis; tente novamente mais tarde
      security:
        - APIKey: []
components:
  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.