List billing documents
Invoices and receipts. platform (the default) is what your agency paid the platform: subscription invoices and your own wallet top-up receipts. sub_accounts is what your sub-accounts paid you, which is always a top-up receipt.
The platform list is assembled from two sources and capped. When the cap is reached, truncated is true and the list is not complete history.
Allowed customer roles: agency_admin. The agency is the one the credential belongs to; no parameter selects another.
Required API key scope: billing:read.
Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Query Parameters
Start of the window. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and read as that day at 00:00:00Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window. Billing windows are whole UTC days, so a timestamp selects the day it falls on. Omit both bounds to read every document.
End of the window, inclusive. Defaults to today. A UTC ISO 8601 timestamp is canonical; a plain YYYY-MM-DD date is accepted and covers that whole day, through 23:59:59.999Z. A timestamp must carry Z or an explicit offset, since one without a zone would be read as server-local time and shift the window. An empty string clears the bound. Anything else is a 400 rather than a silently wrong window. Billing windows are whole UTC days, so a timestamp selects the day it falls on.
Whose payments to list.
platform, sub_accounts Only invoices or only receipts.
ALL, INVOICE, RECEIPT With scope=sub_accounts, only this sub-account's receipts. Refused with any other scope.
1Page number, from 1.
x >= 1Rows per page, at most 100.
1 <= x <= 100