Sign in

v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB
Payments

List payments

get/payments/

Query parameters

pageinteger

Page number to retrieve (1-indexed).

page_sizeinteger

Number of items per page.

orderingstring

Field to sort results by. Prefix with - for descending order (e.g. -created).

customerstring
invoicestring
sourceinteger
sourcesinteger
status'cancelled' | 'failed' | 'incomplete' | 'processing' | 'requires_payment_method' | 'succeeded'
amountnumber
balancenumber
currencystring
datestring date
payment_datestring date-time
descriptionstring

Headers

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Response

Paginated payment list.

countinteger required

Total number of items matching the filter.

nextstring uri nullable

URL of the next page, or null if last page.

previousstring uri nullable

URL of the previous page, or null if first page.

Example response

{
  "count": 142
}