Skip to main content
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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

client_id
string

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=="

status
enum<string>

Filter by payment request status.

Available options:
PENDING,
PAID,
FAILED,
CANCELED,
OVERDUE
Example:

"PENDING"

type
enum<string>

Filter by payment request type.

Available options:
SUBSCRIPTION,
ADDON,
OVERAGE,
ONE_TIME
Example:

"SUBSCRIPTION"

page
integer
default:1

Page number. Default: 1.

Example:

1

page_size
integer
default:20

Results per page. Default: 20. Maximum: 100.

Required range: x <= 100
Example:

20

Response

Payment requests returned successfully.

data
object[]
meta
object