Billing

List payment attempts for a billing statement

Changed on

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.

get/billing/statements/{statementID}/payment_attempts

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/billing/statements/{statementID}/payment_attempts
  • Auth: HTTP bearer

Path parameters

statementIDstring required

The ID of the statement to retrieve payment attempts for.

Query parameters

paginatedboolean

Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

limitinteger

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offsetinteger

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Response

A list of billing payment attempts.

total_countinteger required

Total number of billing payment attempts.

Changes

  • 2025-11-101d47a6af3befRevision changes
    • warning

      added the new payer-credits enum value to the /// response property for the response status

  • 2025-11-10b45c56a4eed9Revision changes
    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status