Understanding your credit statement
Read your credit balance, monthly statements, ledger rows, refunds, and invoice drill-downs
Overview
Kausate records every billable API action in an immutable credit ledger. The ledger is the source of truth for the balance shown in the app, monthly statements, CSV exports, and invoice drill-downs.
There are three kinds of ledger rows:
| Event type | Meaning | Balance effect |
|---|---|---|
consumption | A successful billable action consumed credits | decreases balance |
refund | A previously charged action was reversed | increases balance |
adjustment | An operator correction or migration entry | depends on sign |
Each row includes the SKU, endpoint or capability, customer identifiers, API key identity, company identifiers when available, and the idempotency key that deduplicated the charge.
Balance
Use GET /v2/billing/balance for
the current credit position.
For prepaid accounts, balance is the remaining active grant balance. For
postpaid accounts, balance is the net credit position for the current account;
creditLimit is included when the subscription has a configured limit.
The response also includes:
| Field | Meaning |
|---|---|
accountMode | prepaid or postpaid |
netCreditsCharged | Sum of all ledger credit movements |
prepaidGrantBalance | Remaining active prepaid grants |
postpaidCreditBalance | Negative of net postpaid usage |
validGrantCount | Active grant rows contributing to the prepaid balance |
Monthly statements
Use GET /v2/billing/statements
to fetch monthly statement rows.
Each period contains:
| Field | Meaning |
|---|---|
openingBalance | Balance at the start of the month |
creditsConsumed | Credits charged by consumption rows |
creditsRefunded | Credits returned by refund rows |
netCreditsCharged | Consumption minus refunds and adjustments |
closingBalance | Balance carried into the next month |
eventCount | Number of ledger events in the period |
Pass startMonth and endMonth as dates in the month you want to include, for
example 2026-07-01. Statement ranges are capped to 24 months.
Ledger rows
Use GET /v2/billing/ledger to list
the underlying rows. The endpoint supports keyset pagination with cursor and
filters for startDate, endDate, customerId, sku, and eventType.
Use GET /v2/billing/ledger.csv
for the same ledger in CSV form.
Invoice drill-down
Use
GET /v2/billing/invoices/{invoiceId}
to inspect the billing-run math behind an invoice. The response groups invoice
line items by SKU and includes the exact ledger rows that contributed to each
line.
The invoiceId path parameter accepts either the Stripe invoice id or the
internal billing-run id.
Last updated on