Skip to main content
GET
List billing payments

Yetkilendirmeler

Authorization
string
header
gerekli

The access token received from the authorization server in the OAuth 2.0 flow.

Başlıklar

X-Tenant
number
gerekli

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Sorgu Parametreleri

status
enum<string> | null

Filter by status (pending, authorized, success, failed, refunded, partially_refunded).

Mevcut seçenekler:
pending,
authorized,
success,
failed,
refunded,
partially_refunded,
null
method
enum<string> | null

Filter by payment method (psp, bank_transfer, cash, cheque, offset).

Mevcut seçenekler:
psp,
bank_transfer,
cash,
cheque,
offset,
null
proforma_invoice_id
integer | null

Filter by proforma invoice ID.

Gerekli aralık: x >= 1
completed_at_from
string<date-time> | null

Filter records completed on or after this date.

completed_at_to
string<date-time> | null

Filter records completed on or before this date.

created_at_from
string<date-time> | null

Filter records created on or after this date.

created_at_to
string<date-time> | null

Filter records created on or before this date.

per_page
integer | null

The number of items per page.

Gerekli aralık: 1 <= x <= 100
page
integer | null

The page number.

Gerekli aralık: x >= 1
sort_by
enum<string> | null

The field to sort by.

Mevcut seçenekler:
created_at,
completed_at,
amount,
null
sort_order
enum<string> | null

The sort direction (asc or desc).

Mevcut seçenekler:
asc,
desc,
null

Yanıt

Paginated set of BillingPaymentResource

data
BillingPaymentResource · object[]
gerekli
meta
object
gerekli