Skip to main content

TransactionDisplayRead

One row of the company's billing ledger, as shown to clients. Costs are negative, top-ups positive. LLM usage (token_usage) amounts include the company's cost markup; top-ups and flat fees (channel_fee) are shown at face value.

idIdrequired

Unique numeric identifier of the record.

company_idCompany Idrequired

ID of the owning company (the top-level tenant account).

amountAmountrequired

Signed amount. Negative for costs (token_usage, channel_fee), positive for top-ups.

Possible values: Value must match regular expression ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

entry_typeTransactionTyperequired

What the row bills — token_usage (LLM), channel_fee (monthly messaging-channel fee) or topup.

Possible values: [token_usage, channel_fee, topup]

channel_id object

For channel_fee rows — the billed channel. Null for other entry types or when the channel was deleted.

anyOf
integer
paid_until object

For channel_fee rows — the end of the prepaid period this fee covers.

anyOf
date-time
created_atdate-timerequired

Creation time (UTC, ISO 8601).

TransactionDisplayRead
{
  "id": 0,
  "company_id": 0,
  "amount": "string",
  "entry_type": "token_usage",
  "channel_id": 0,
  "paid_until": "2024-07-29T15:51:28.071Z",
  "created_at": "2024-07-29T15:51:28.071Z"
}