Pular para o conteúdo 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.

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
ledgerId
string
obrigatório

Identificador único do Ledger para calcular o billing.

period
string
obrigatório

Período de billing. Formatos suportados: YYYY-MM (mensal), YYYY-Www (semanal, ex. 2026-W13), ou YYYY-MM-DD (diário).

type
enum<string>

Filtrar por tipo de billing. Quando omitido, tanto pacotes de volume quanto de manutenção são calculados.

Opções disponíveis:
volume,
maintenance

Resposta

Resultados do cálculo de billing com payloads de transação.

results
object[]

Um resultado por cada pacote de billing ativo processado.

summary
object

Totais consolidados de todos os resultados.