Retrieve all payments

Retrieve a list of payments based on provided filters

Required scopes: flex.billing.payments.read

Path Params
string
required

organization slug

Query Params
string

Filter by a list of payment ids

string

Filter by member id of the payment.

string

Filter by company id of the payment.

string

Filter by the issue date of the document. Supports date comparison filters: $gt, $gte, $lt, $lte

string

Filter by the due date of the document. Supports date comparison filters: $gt, $gte, $lt, $lte

string

Filter by the document number for the payment.

string

Filter by location id of the payment.

string
enum

Filter by the type of the document.
It could be either invoice, creditNote, or overpayment.
If omitted, invoice is assumed.

Allowed:
string

Filter by status of the invoice, credit note, or overpayment.
Supports both single status values (e.g., status=paid) and array operations (e.g., status[$in]=paid,pending).
Note: Multiple values in simple string format (e.g., status=paid,pending) are not allowed - use status[$in] format instead.

string

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

string

Support date comparison filters: $gt, $gte, $lt, $lte

string

Select fields to return

string
string
number
string
^[^:]+:(asc|desc)$

Sort expression in the format <field>:<order>, where order is asc or desc

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json