Skip to main content
GET
cURL
Required scope: billing:read Read annual prepayments, customer top-ups and promotional additions. Filters use initiated_at and ordering is initiated_at then id. Only settled funding adds credits; pending payments remain excluded. Invoice and receipt references are populated when issued. Payment method type is shown without bank or card credentials. Funding source is audit provenance, not a separate spending balance or consumption priority. No endpoint initiates, retries or cancels a payment. Required scope: billing:read. The API key is bound to exactly one workspace, institution and environment. There is no workspace override; this binding applies to every read and export. Product scope · Processing lifecycle · Errors

Authorizations

Authorization
string
header
required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Query Parameters

from
string<date-time>

Inclusive UTC boundary; provide with to.

to
string<date-time>

Exclusive UTC boundary; provide with from.

source
enum<string>

Funding source.

Available options:
annual_prepayment,
customer_top_up,
promotional_top_up
status
enum<string>

Funding status.

Available options:
pending,
settled,
failed,
cancelled
snapshot_id
string

Reuse an immutable snapshot from this workspace. Omit to use a current snapshot. Cursors bind this value; unknown snapshots return 404 and conflicting cursor parameters return 400.

limit
integer

Page size; default 100, maximum 200.

Required range: 1 <= x <= 200
cursor
string

Opaque cursor bound to filters and a stable snapshot.

Response

Successful response.

data
object[]
required
page
object
required
meta
object
required