Saltar al contenido 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.

Encabezados

​
X-Organization-Id
string
requerido

Identificador único de la organización asociada a la solicitud.

Ejemplo:

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

​
Authorization
string

El token de autorización en formato 'Bearer '.

Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

​
Content-Type
string
requerido

Tipo de medio del recurso. Debe ser application/json.

Ejemplo:

"application/json"

Cuerpo

application/json

Cuerpo de la solicitud para crear un paquete de billing. El conjunto de campos requeridos depende de type.

  • Los paquetes volume requieren eventFilter, pricingModel, al menos una entrada en tiers, assetCode, debitAccountAlias y creditAccountAlias.
  • Los paquetes maintenance requieren feeAmount, assetCode, maintenanceCreditAccount y accountTarget. enable es opcional; cuando se omite, el servicio lo establece en true por defecto.
​
type
enum<string>
requerido

Tipo de billing: volume o maintenance.

Opciones disponibles:
volume,
maintenance
Allowed value: "volume"
​
label
string
requerido

Nombre del paquete de billing.

​
ledgerId
string
requerido

Ledger que registra las transacciones de billing.

​
eventFilter
object
requerido

(Solo volumen) Filtro para determinar qué transacciones contar.

​
pricingModel
enum<string>
requerido

(Solo volumen) Modelo de precios.

Opciones disponibles:
tiered,
fixed
​
tiers
object[]
requerido

(Solo volumen) Rangos de cantidad y precios unitarios. Se requiere al menos un tramo.

Minimum array length: 1
​
assetCode
string
requerido

Código de moneda (ej., BRL).

​
debitAccountAlias
string
requerido

(Solo volumen) Cuenta a debitar.

​
creditAccountAlias
string
requerido

(Solo volumen) Cuenta a acreditar.

​
description
string

Descripción opcional.

​
enable
boolean
predeterminado:true

Si el paquete está activo. Opcional. Si se omite, el valor predeterminado es true.

​
freeQuota
integer

(Solo volumen) Transacciones exentas antes de cobrar.

​
discountTiers
object[]

(Solo volumen) Umbrales de descuento progresivo.

​
countMode
enum<string>

(Solo volumen) Cómo se agrupan las transacciones.

Opciones disponibles:
perRoute,
perAccount
​
feeAmount
string

(Solo mantenimiento) Tarifa fija por cuenta activa. Valor decimal como string (por ejemplo, "9.90").

​
maintenanceCreditAccount
string

(Solo mantenimiento) Cuenta que recibe la tarifa.

​
accountTarget
object

(Solo mantenimiento) Cuentas objetivo. Proporciona exactamente uno de segmentId, portfolioId o aliases.

Respuesta

Paquete de billing creado exitosamente.

​
id
string

Identificador único del paquete de billing.

​
label
string
​
description
string
​
type
enum<string>
Opciones disponibles:
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