List Payment Requests
Payment Requests
List Payment Requests
Retrieve a paginated list of payment requests for your tenant, with optional filters for client, status, and type.
GET
List Payment Requests
This endpoint requires a PRO plan or above. If your plan does not include the External Billing API, the request returns
403 with error code external_billing_api.Combining filters
All query parameters are optional and can be used together or individually:Payment request statuses
Payment request types
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter payment requests for a specific client. Accepts a plain integer ID or a base64 GraphQL global ID. Omit to return all clients under the tenant.
Example:
"Q2xpZW50OjEyMw=="
Filter by payment request status.
Available options:
PENDING, PAID, FAILED, CANCELED, OVERDUE Example:
"PENDING"
Filter by payment request type.
Available options:
SUBSCRIPTION, ADDON, OVERAGE, ONE_TIME Example:
"SUBSCRIPTION"
Page number. Default: 1.
Example:
1
Results per page. Default: 20. Maximum: 100.
Required range:
x <= 100Example:
20

