Clerk API (unofficial showcase)
GET/billing/statements/{statementID}/payment_attempts

List payment attempts for a billing statement

Returns a list of all payment attempts for a specific billing statement. The payment attempts are returned sorted by creation date, with the newest payment attempts appearing first. Pagination is supported.

4 parameters
statementIDstringrequired
The ID of the statement to retrieve payment attempts for.
paginatedbooleanoptional
Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
limitintegeroptional
Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
Default:10
offsetintegeroptional
Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
Default:0

6 status codes
200A list of billing payment attempts.
dataarray<object>required
Array of billing payment attempts.
total_countintegerrequired
Total number of billing payment attempts.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
500Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 404 is returned: Resource not found. A 422 is returned: Invalid request parameters. A 500 is returned: Request was not successful.