Billing

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.

get/billing/statements/{statementID}/payment_attempts

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

Changed in 3 of the 15 revisions of this API.14

    • added the new payer-credits enum value to the data/items/payment_method/payment_type response property for the response status 200

      response-property-enum-value-added

    • added CommerceTotalsResponse-2 to the data/items/totals response property allOf list for the response status 200

      response-property-all-of-added

    • removed schemas-CommerceTotalsResponse from the data/items/totals response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added schemas-CommerceTotalsResponse to the data/items/totals response property allOf list for the response status 200

      response-property-all-of-added

    • removed CommerceTotalsResponse from the data/items/totals response property allOf list for the response status 200

      response-property-all-of-removed