Pular para o conteúdo principal
POST
/
v1
/
billing-packages
curl --request POST \ --url https://fees.sandbox.lerian.net/v1/billing-packages \ --header 'Content-Type: <content-type>' \ --header 'X-Organization-Id: <x-organization-id>' \ --data ' { "label": "Pix Send Monthly Billing", "description": "Monthly volume billing for Pix transactions", "ledgerId": "ldg_01HZ...", "type": "volume", "enable": true, "eventFilter": { "transactionRoute": "pix-send", "status": "APPROVED" }, "pricingModel": "tiered", "tiers": [ { "minQuantity": 1, "maxQuantity": 100, "unitPrice": "0.50" }, { "minQuantity": 101, "maxQuantity": 500, "unitPrice": "0.35" }, { "minQuantity": 501, "maxQuantity": null, "unitPrice": "0.20" } ], "freeQuota": 10, "discountTiers": [ { "minQuantity": 200, "discountPercentage": "5.00" }, { "minQuantity": 400, "discountPercentage": "10.00" } ], "countMode": "perAccount", "assetCode": "BRL", "debitAccountAlias": "client-wallet", "creditAccountAlias": "fees-revenue" } '
{ "id": "bpkg_01HZ...", "label": "Pix Send Monthly Billing", "type": "volume", "enable": true, "organizationId": "org_01HZ...", "ledgerId": "ldg_01HZ...", "createdAt": "2026-03-01T00:00:00Z", "updatedAt": "2026-03-01T00:00:00Z" }

Cabeçalhos

​
X-Organization-Id
string
obrigatório

O identificador único da Organização associada à requisição.

Exemplo:

"019c96a0-0a98-7287-9a31-786e0809c769"

​
Authorization
string

O token de autorização no formato 'Bearer '.

Importante: Este header é obrigatório se o seu ambiente possui o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

​
Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

Exemplo:

"application/json"

Corpo

application/json

Corpo da requisição para criar um pacote de billing. Os campos variam conforme o tipo.

​
label
string
obrigatório

Nome do pacote de billing.

​
ledgerId
string
obrigatório

Ledger que registra as transações de billing.

​
type
enum<string>
obrigatório

Tipo de billing: volume ou maintenance.

Opções disponíveis:
volume,
maintenance
​
enable
boolean
obrigatório

Se o pacote está ativo.

​
description
string

Descrição opcional.

​
eventFilter
object

(Apenas volume) Filtro para determinar quais transações contar.

​
pricingModel
enum<string>

(Apenas volume) Modelo de preços.

Opções disponíveis:
tiered,
fixed
​
tiers
object[]

(Apenas volume) Faixas de quantidade e preços unitários.

​
freeQuota
integer

(Apenas volume) Transações isentas antes da cobrança.

​
discountTiers
object[]

(Apenas volume) Limites de desconto progressivo.

​
countMode
enum<string>

(Apenas volume) Como as transações são agrupadas.

Opções disponíveis:
perRoute,
perAccount
​
assetCode
string

Código da moeda (ex., BRL).

​
debitAccountAlias
string

(Apenas volume) Conta a debitar.

​
creditAccountAlias
string

(Apenas volume) Conta a creditar.

​
feeAmount
string

(Apenas manutenção) Taxa fixa por conta ativa.

​
maintenanceCreditAccount
string

(Apenas manutenção) Conta que recebe a taxa.

​
accountTarget
object

(Apenas manutenção) Contas alvo. Use exatamente uma propriedade.

Resposta

Pacote de billing criado com sucesso.

​
id
string

Identificador único do pacote de billing.

​
label
string
​
description
string
​
type
enum<string>
Opções disponíveis:
volume,
maintenance
​
enable
boolean
​
organizationId
string
​
ledgerId
string
​
eventFilter
object
​
pricingModel
string
​
tiers
object[]
​
freeQuota
integer
​
discountTiers
object[]
​
countMode
string
​
assetCode
string
​
debitAccountAlias
string
​
creditAccountAlias
string
​
feeAmount
string
​
maintenanceCreditAccount
string
​
accountTarget
object
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
deletedAt
string<date-time> | null