List invoices
List this account’s invoices.
/account/invoicesdata:readAn unrestricted account key owned by a current account Admin is required.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Query parameters
limitintegerOptionalRecords per page, from 1 to 200.
Default:
50cursorstringOptionalOpaque nextCursor from the preceding response.
Response fields
dataobject[]RequiredList this account’s invoices.
Child fields
idstringRequiredSaved invoice id. Monetary amounts use the currency’s minor unit.
numberstring | nullRequiredSaved invoice number. Monetary amounts use the currency’s minor unit.
statusstringRequiredSaved invoice status. Monetary amounts use the currency’s minor unit.
currencystringRequiredSaved invoice currency. Monetary amounts use the currency’s minor unit.
subtotalintegerRequiredSaved invoice subtotal. Monetary amounts use the currency’s minor unit.
totalintegerRequiredSaved invoice total. Monetary amounts use the currency’s minor unit.
amountPaidintegerRequiredSaved invoice amountPaid. Monetary amounts use the currency’s minor unit.
amountDueintegerRequiredSaved invoice amountDue. Monetary amounts use the currency’s minor unit.
issuedAtISO 8601 timestampRequiredSaved invoice issuedAt. Monetary amounts use the currency’s minor unit.
dueAtISO 8601 timestamp | nullRequiredSaved invoice dueAt. Monetary amounts use the currency’s minor unit.
periodStartISO 8601 timestamp | nullRequiredSaved invoice periodStart. Monetary amounts use the currency’s minor unit.
periodEndISO 8601 timestamp | nullRequiredSaved invoice periodEnd. Monetary amounts use the currency’s minor unit.
paginationobjectRequiredCursor pagination for resource lists.
Child fields
hasMorebooleanRequiredWhether another page exists.
nextCursorstring | nullRequiredPass this unchanged as cursor with the same key, path, limit and filters.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.