GET/account_statements

List Account Statements

Lists Account Statements, with optional filters for Account and statement period start time. Use cursor and limit to paginate the results; limit defaults to 100 and cannot exceed 100.

7 parameters
cursorstringoptional
Cursor identifying the position after which to return the next page of entries.
limitintegeroptional
Maximum number of Account Statements to return. Must be at least 1 and defaults to 100 when omitted.
Default:100
account_idstringoptional
Filter Account Statements to those belonging to the specified Account.
statement_period_start.afterstringoptional
Return results after this ISO 8601 timestamp.
statement_period_start.beforestringoptional
Return results before this ISO 8601 timestamp.
statement_period_start.on_or_afterstringoptional
Return results on or after this ISO 8601 timestamp.
statement_period_start.on_or_beforestringoptional
Return results on or before this ISO 8601 timestamp.

3 status codes
200Returns a paginated list of Account Statement objects and a `next_cursor` for retrieving the next page.
dataarray<AccountStatement>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request encounters a client error.
5XXReturned when the service encounters a server error.

Error handling

limit must be at least 1 and no more than 100. Statement period filters must be valid ISO 8601 timestamps.