Skip to main content
GET
Customer account-credit statement

What it returns

A single, reconciled view of a customer’s account credit:
  • balances — spendable balance per currency (and legal entity). This equals exactly what the billing engine can apply to invoices: adjustment credits with status issued and a positive balance.
  • grants — every credit note for the customer (including fully-drawn used, expired, and refund notes), newest first.
  • applications — the draw-down history: which credit note settled which invoice, for how much, and when.
  • summary — a per-currency rollup of total issued, total applied, and the current spendable balance.

Example request

Example response

The statement’s spendable balance is computed the same way the billing engine selects credit to apply, so it can never disagree with what the customer can actually spend. It reconciles to the Customer Credit (2300) ledger account.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Path Parameters

id
string<uuid>
required

Response

The credit statement.

data
object