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

# Cobrança no Fees Engine

> Novos Billing Packages e Billing Calculation no Fees Engine, com novos endpoints, 19 novos códigos de erro e OpenAPI v3.1.0 cobrindo cobrança por volume e por manutenção.

14 de abril de 2026Atualização da documentaçãoRevisão recomendada

## Afeta

***

Equipes que usam os Billing Packages ou o Billing Calculation do Fees Engine.

Esta atualização se aplica ao portal público de documentação. Ela não muda o comportamento da API em runtime, a menos que a documentação do produto vinculada diga o contrário.

## O que mudou

***

Esta atualização traz documentação para duas novas capacidades do Fees Engine: Billing Packages e Billing Calculation. Esses recursos permitem configurar modelos de cobrança recorrente (por volume e por manutenção) e calcular cobranças automaticamente com base na atividade do ledger.

### Billing Packages: cobrança por volume e por manutenção

***

Os Billing Packages permitem definir como sua plataforma cobra os clientes pelo uso. O Fees Engine agora oferece suporte a dois tipos de cobrança:

* **Cobrança por volume**: cobranças baseadas na contagem de transações dentro de um período, com suporte a precificação por faixas, cotas gratuitas e faixas de desconto
* **Cobrança por manutenção**: cobranças baseadas no número de contas ativas em um segmento ou portfólio

### O que há de novo

* Nova [**Referência da API de Billing Packages**](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-billing-package.md): endpoints CRUD completos para criar, listar, recuperar, atualizar e excluir billing packages
* Novo [**endpoint de Billing Calculation**](https://docs.lerian.studio/pt/reference/products/midaz/v2/calculate-billing.md): POST /v1/billing/calculate calcula as cobranças de um ledger e período
* Nova página [**Exemplos de Billing Package**](https://docs.lerian.studio/pt/products/midaz/fees/billing-package-examples.md) com quatro cenários reais: precificação de boleto por faixas, cobrança por volume de Pix com faixas de desconto, cobrança por manutenção de contas e cobrança combinada de volume + manutenção
* [**Visão geral do Fees Engine**](https://docs.lerian.studio/pt/products/midaz/fees/fees-engine-overview.md) atualizada com os conceitos de billing package, o formato de período (ISO 8601 YYYY-MM e YYYY-Www) e as regras de validação
* Guia [**Cálculo de tarifas**](https://docs.lerian.studio/pt/products/midaz/fees/fee-engine-calculation.md) atualizado com o fluxo de cálculo de cobrança: freeQuota → tiers → discountTiers, semântica de countMode (perRoute vs perAccount), comportamento tudo-ou-nada e metadados de auditoria
* [**Usando o Fees Engine**](https://docs.lerian.studio/pt/products/midaz/fees/using-fee-engine.md) atualizado com o workflow de configuração de billing package
* [**Boas práticas**](https://docs.lerian.studio/pt/products/midaz/fees/fees-engine-best-practices.md) atualizadas com orientações específicas de cobrança sobre seleção de período, isenções por segmento e estratégia de faixas de desconto

### Modelos de precificação e integração com o Ledger

Se sua plataforma precisa cobrar clientes com base no volume de transações ou em contas ativas, os Billing Packages dão uma forma declarativa de definir modelos de precificação. Esses modelos incluem precificação por faixas com aplicação automática de desconto. O endpoint de cálculo retorna um transactionPayload pronto para executar, que você pode enviar direto ao Ledger, então a cobrança fica totalmente integrada aos seus registros financeiros.

### Catálogo de erros atualizado

***

A [Lista de erros do Fees Engine](https://docs.lerian.studio/pt/reference/products/midaz/v2/estimate-fee-calculation.md) foi ampliada com 19 novos códigos de erro (FEE-0052 até FEE-0070) que cobrem validações específicas de cobrança:

* Campos de billing package ausentes ou inválidos (period, type, pricingModel, feeAmount, assetCode)
* Erros de configuração de faixas (faixas sobrepostas, limites ausentes, percentuais de desconto inválidos)
* Falhas de cálculo (resolução de segmento, dependências de serviço)
* Validação do alvo da conta (segmentId, portfolioId ou aliases: exatamente um é obrigatório)

O catálogo total de erros agora cobre 69 códigos de erro em todas as operações do Fees Engine.

### Especificação OpenAPI atualizada para v3.1.0

***

A especificação OpenAPI do Fees Engine passou de v3.0.0 para v3.1.0, refletindo todos os novos endpoints e schemas:

* POST /v1/billing-packages: [Criar um billing package](https://docs.lerian.studio/pt/reference/products/midaz/v2/create-billing-package.md)
* GET /v1/billing-packages: [Listar billing packages](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-all-billing-packages.md)
* GET /v1/billing-packages/{id}: [Recuperar um billing package](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-billing-package-by-id.md)
* PATCH /v1/billing-packages/{id}: [Atualizar um billing package](https://docs.lerian.studio/pt/reference/products/midaz/v2/update-billing-package.md)
* DELETE /v1/billing-packages/{id}: [Excluir um billing package](https://docs.lerian.studio/pt/reference/products/midaz/v2/delete-billing-package.md)
* POST /v1/billing/calculate: [Calcular a cobrança de um ledger e período](https://docs.lerian.studio/pt/reference/products/midaz/v2/calculate-billing.md)

Novos schemas: CreateBillingPackageRequest, UpdateBillingPackageRequest, BillingPackageResponse, CalculateBillingRequest, CalculateBillingResponse.

## Impacto

***

Esta é uma atualização de documentação. As integrações existentes não precisam de migração apenas por esta nota de release.

## O que você precisa fazer

***

**Step 1**

Revise a documentação de Billing Packages e Billing Calculation antes de configurar modelos de cobrança recorrente.

### Prazo

Nenhum.

### Por quê

A documentação agora cobre as capacidades de cobrança do Fees Engine, os exemplos e os códigos de erro ampliados.


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