GET/v1/billing/summary

Billing summary

The billing mode and the figures in cents: balance, reserved for READY items, available (balance minus reserved), outstanding (INVOICE), the credit limit and headroom, the trial allowance and the low balance threshold.

Scope billing.read

Returns

14 fields of the 200 answer

organisationIdstringrequired

billingModeenumrequired

PREPAIDTRIALINVOICE

currencystringrequired

balanceCentsintegerrequired

reservedCentsintegerrequired

availableCentsintegerrequired

outstandingCentsintegerrequired

creditLimitCentsintegerrequired

creditHeadroomCentsinteger or nullrequired

trialobject or nullrequired

3 fields

itemsRemainingintegerrequired

expiresAtdate-time or nullrequired

activebooleanrequired

lowBalanceThresholdCentsinteger or nullrequired

lowBalanceNotifiedAtdate-time or nullrequired

reconciledAtdate-time or nullrequired

updatedAtdate-timerequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

{ "organisationId": "org_01J9Y2K8QF4T6W8Z0B2D4F6H8K", "billingMode": "PREPAID", "currency": "EUR", "balanceCents": 1250, "reservedCents": 1250, "availableCents": 1250, "outstandingCents": 1250, "creditLimitCents": 1250, "creditHeadroomCents": 1250, "trial": { "itemsRemaining": 1, "expiresAt": "2026-10-16T09:14:02.000Z", "active": true }, "lowBalanceThresholdCents": 1250, "lowBalanceNotifiedAt": "2026-10-16T09:14:02.000Z", "reconciledAt": "2026-10-16T09:14:02.000Z", "updatedAt": "2026-10-16T09:14:02.000Z" }