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

# Fatura projetada

> Calcule um detalhamento de fatura projetado com base nos volumes esperados de cunhagem e verificação.

```http theme={null}
POST /v1/billing/projected-invoice
```

Retorna uma projeção de fatura detalhada com base nos volumes de uso que você fornece. A autenticação é necessária. Use sua chave de API de espaço de trabalho. Use-a para calculadoras de preços, previsão de custos ou ferramentas de pré-venda.

Ajustes de preços regionais são aplicados quando você inclui um `country_code`. Este endpoint usa a tabela de preços padrão, não um acordo negociado do locatário. Forneça quantidades **faturáveis** esperadas; esta calculadora não deduz subsídios gratuitos nem classifica a atividade de sandbox.

O preço por volume é graduado. Cada faixa precifica apenas as operações nessa faixa. A resposta identifica `billing_model: "pay_per_use"`, `volume_pricing: "graduated"`, `amount_unit: "cents"` e `estimate_only: true`. Uma estimativa não cria ou cobra uma fatura. Definições de taxa ausentes, sobrepostas ou incompletas retornam `422 invalid_pricing`; quantidades inseguras e planos desconhecidos retornam `400 bad_request`.

Os preços exatos aplicados estão em `line_items`. Os campos escalares de conveniência `rates_used` são mantidos para compatibilidade com tabelas de preços fixos; eles não são um preço combinado e não devem ser multiplicados em faixas de volume.

## Resposta

**line\_items** `object[]`

Detalhes dos encargos projetados.

**description** `string`

Descrição do item de linha (por exemplo, "Cunhagens de credenciais").

**quantity** `integer`

Número de unidades.

**unit\_price\_cents** `integer`

Preço por unidade em centavos.

**total\_cents** `integer`

Custo total para este item de linha em centavos.

**subtotal** `integer`

Subtotal de encargos de uso em centavos (antes da taxa da plataforma).

**total** `integer`

Custo total projetado em centavos (uso + taxa de plataforma).

**currency** `string`

Código da moeda da tabela de preços (atualmente `USD`).

**rates\_used** `object`

As taxas aplicadas a esta projeção.

**mint\_rate\_cents** `integer`

Taxa por cunhagem em centavos.

**verify\_rate\_cents** `integer`

Taxa por verificação em centavos.

**platform\_fee** `integer`

Taxa mensal da plataforma em centavos.

**region** `string`

Nível de preço regional aplicado.

**multiplier** `number`

Multiplicador de preço regional.

> [!NOTE]
>
> Todos os valores estão em centavos. Divida por 100 para converter para dólares. Multiplicadores regionais são aplicados automaticamente quando você inclui um `country_code`.


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/billing/projected-invoice
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/projected-invoice:
    post:
      tags:
        - Billing
      summary: Próxima fatura do projeto
      description: >-
        Estima as quantidades faturáveis de cunhagem e verificação usando a
        tabela de preços padrão e as faixas de volume graduadas. Não cobra, não
        resolve preços negociados privados, nem deduz subsídios gratuitos. Os
        valores são em centavos inteiros.
      operationId: billing.projectedInvoice
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                country_code:
                  type: string
                mints:
                  type: integer
                  minimum: 0
                  maximum: 1000000000
                plan_key:
                  type: string
                verifications:
                  type: integer
                  minimum: 0
                  maximum: 1000000000
              type: object
      responses:
        '200':
          description: Fatura projetada
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  subtotal:
                    type: integer
                  amount_unit:
                    type: string
                    enum:
                      - cents
                  billing_model:
                    type: string
                    enum:
                      - pay_per_use
                  volume_pricing:
                    type: string
                    enum:
                      - graduated
                  estimate_only:
                    type: boolean
                  currency:
                    type: string
                  line_items:
                    type: array
                    items:
                      type: object
        '400':
          description: Quantidade inválida ou plano desconhecido
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: As taxas configuradas não podem precificar este uso
      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.