Version 2.1.1792967583 · latest Download OpenAPI Markdown

Ledger entries

Every change to an account balance, each with a balance snapshot taken after posting.

ledger-entriesBillingAuthentication: User (some parameters admin only)1 endpoints

List ledger entries

GET/api/v2/ledger-entries

Authentication: User (some parameters admin only)

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
tenant_id	integer	—	Admin only: filter by tenant. Ignored for tenant credentials, which only see their own tenant's data
kind	string	—	Filter by ledger entry kind.
start	string	—	Entry time from (inclusive), RFC 3339.
end	string	—	Entry time until (exclusive), RFC 3339.

Field	Type	Required	Description
amount_cents	integer	—	Signed: positive for credit, negative for debit.
balance_after_cents	integer	—	Balance snapshot after this entry.
created_at	string	—	Created at
des	string	—	Description
id	integer	—	Record ID
kind	string	—	Entry kind, such as recharge or deduction.
order_id	integer	—	Related order ID; empty if none.
tenant_id	integer	—	Owner tenant (user) ID