Saltar al contenido principal
POST
/
v1
/
billing
/
calculate
curl --request POST \
  --url https://fees.sandbox.lerian.net/v1/billing/calculate \
  --header 'Content-Type: <content-type>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "ledgerId": "ldg_01HZ...",
  "period": "2026-03",
  "type": "volume"
}
'
{
  "results": [
    {
      "billingPackageId": "<string>",
      "billingPackageLabel": "<string>",
      "period": "<string>",
      "totalAccounts": 123,
      "totalCharged": 123,
      "totalSkipped": 123,
      "totalNetAmount": "<string>",
      "transactionPayload": {}
    }
  ],
  "summary": {
    "totalResults": 123,
    "totalVolume": 123,
    "totalMaintenance": 123,
    "totalNetAmount": "<string>"
  }
}

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
ledgerId
string
requerido

Identificador único del Ledger para calcular el billing.

period
string
requerido

Periodo de billing. Formatos soportados: YYYY-MM (mensual), YYYY-Www (semanal, ej. 2026-W13), o YYYY-MM-DD (diario).

type
enum<string>

Filtrar por tipo de billing. Cuando se omite, se calculan tanto los paquetes de volumen como de mantenimiento.

Opciones disponibles:
volume,
maintenance

Respuesta

Resultados del cálculo de billing con payloads de transacción.

results
object[]

Un resultado por cada paquete de billing activo procesado.

summary
object

Totales consolidados de todos los resultados.