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

> Retorna os contadores de uso do ciclo de faturamento atual para o locatário autenticado.

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

Retorna contadores de uso medidos para o período de faturamento atual. Cada contador rastreia um recurso faturável e mostra o quanto você consumiu em relação ao limite do seu plano.

## Resposta

Retorna um array de objetos de contador de uso.

**metric** `string`

O identificador da métrica de uso (por exemplo, `attestations.mint`, `verifications_monthly`, `storage_bytes`).

**used** `integer`

Valor consumido no período de faturamento atual.

**limit** `integer`

Máximo permitido para esta métrica em seu plano. Um valor de `-1` indica que não há cota configurada para esta métrica; os limites de serviço e taxa ainda se aplicam.

**period** `string`

Período de faturamento para este contador: `monthly` ou `total`.

**unit** `string`

Unidade de medida: `count` ou `bytes`.

**allowed** `boolean`

Se o locatário está atualmente autorizado a consumir mais desta métrica. Retorna `false` quando o limite foi atingido. Incluído apenas quando relevante.

**delta** `integer`

Mudança no uso desde a última consulta. Incluído apenas quando o servidor rastreia atualizações incrementais.

### Métricas rastreadas

O endpoint de uso retorna até 16 métricas organizadas por grupo de produto. Quais métricas aparecem depende do seu plano e dos recursos ativos.

#### Principal

| Métrica | Descrição | Unidade |
| - | - | - |
| `attestations.mint` | Atestados cunhados | `count` |
| `verifications_monthly` | Verificações realizadas | `count` |
| `storage_bytes` | Armazenamento total consumido | `bytes` |
| `proof_bundles` | Pacotes de prova gerados | `count` |
| `webhook_endpoints` | Pontos de extremidade de webhook ativos | `count` |
| `webhook_deliveries` | Entregas de webhook enviadas | `count` |
| `seats` | Assentos de membros da equipe | `count` |

#### MAIP (Identidade da Máquina)

| Métrica | Descrição | Unidade |
| - | - | - |
| `maip.agents` | Agentes de máquina registrados | `count` |
| `maip.sessions` | Sessões de agente criadas | `count` |
| `maip.trust_computes` | Cálculos de pontuação de confiança | `count` |
| `maip.compliance_checks` | Pedidos de verificação de conformidade | `count` |

#### IA

| Métrica | Descrição | Unidade |
| - | - | - |
| `ai.dataset_attestations` | Conjuntos de dados atestados para linhagem | `count` |
| `ai.model_attestations` | Modelos atestados para proveniência | `count` |

#### Antifraude

| Métrica | Descrição | Unidade |
| - | - | - |
| `antifraud.risk_signals` | Sinais de risco ingeridos ou gerados | `count` |
| `antifraud.deepfake_scans` | Pedidos de análise de deepfake | `count` |
| `antifraud.velocity_records` | Registros de pontuação de velocidade | `count` |

> [!TIP]
>
> Para verificar se uma operação específica é permitida antes de executá-la, use o [endpoint de direitos](https://docs.truthlocks.com/pt/api-reference/billing/entitlements.md) para verificar suas cotas.

## Painel do Console

Você também pode visualizar o uso graficamente no console em **Configurações > Cobrança > Uso**. O painel mostra todas as 16 métricas organizadas por grupo de produtos (Core, MAIP, AI e Anti-Fraude), cada uma exibida como uma barra de progresso em relação ao limite do seu plano. Um custo mensal projetado é calculado com base no seu consumo atual e nas taxas efetivas por unidade.


## OpenAPI

````yaml pt/mint-openapi.yaml GET /v1/billing/usage
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:
    get:
      tags:
        - Billing
      summary: Obter uso de faturamento
      description: Retorna o uso medido para o período de faturamento atual.
      operationId: billing.usage
      parameters:
        - name: period
          in: query
          schema:
            type: string
          description: Período de faturamento (por exemplo, "2026-04")
      responses:
        '200':
          description: Dados de uso
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: string
                  usage:
                    type: object
                    additionalProperties: true
        '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.