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"
}

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.

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. O conjunto de campos obrigatórios depende de type.

  • Pacotes volume exigem eventFilter, pricingModel, ao menos uma entrada em tiers, assetCode, debitAccountAlias e creditAccountAlias.
  • Pacotes maintenance exigem feeAmount, assetCode, maintenanceCreditAccount e accountTarget. enable é opcional; quando omitido, o serviço assume true por padrão.
type
enum<string>
obrigatório

Tipo de billing: volume ou maintenance.

Opções disponíveis:
volume,
maintenance
Allowed value: "volume"
label
string
obrigatório

Nome do pacote de billing.

ledgerId
string
obrigatório

Ledger que registra as transações de billing.

eventFilter
object
obrigatório

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

pricingModel
enum<string>
obrigatório

(Apenas volume) Modelo de preços.

Opções disponíveis:
tiered,
fixed
tiers
object[]
obrigatório

(Apenas volume) Faixas de quantidade e preços unitários. É obrigatório informar pelo menos uma faixa.

Minimum array length: 1
assetCode
string
obrigatório

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

debitAccountAlias
string
obrigatório

(Apenas volume) Conta a debitar.

creditAccountAlias
string
obrigatório

(Apenas volume) Conta a creditar.

description
string

Descrição opcional.

enable
boolean

Se o pacote está ativo. Opcional. Se omitido, o valor padrão é true.

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
feeAmount
string

(Apenas manutenção) Taxa fixa por conta ativa. Valor decimal como string (por exemplo, "9.90").

maintenanceCreditAccount
string

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

accountTarget
object

(Apenas manutenção) Contas alvo. Informe exatamente um entre segmentId, portfolioId ou aliases.

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