Skip to main content
GET
List all payment links

Authorizations

Authorization
string
header
required

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

Query Parameters

ids
integer[] | null

When provided, filters to objects with these IDs.

ending_before
integer | null

A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as starting_after.

starting_after
integer | null

A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as ending_before.

limit
integer
default:10

The maximum number of items to return per page.

Required range: 1 <= x <= 100
clinic_id
integer | null

When provided, filters payment links by clinic ID.

clinic_client_id
integer | null

When provided, filters payment links by clinic client ID.

is_expired
boolean | null

When True, filters to payment links that have expired, and when False, filters to payment links that are still active. When None, then both are included.

is_paid
boolean | null

When True, filters to payment links that have been paid, and when False, filters to payment links that have no been paid. When None, then both are included.

Response

200 - application/json

OK

data
ExternalPaymentLinkDetailSchema · object[]
required

A single page of data contained within this list.

next_page
string
required

A URL linking to the next page of this list.

has_more
boolean
default:false

Whether there are more pages or data in this list.

type
string
default:list

Type of this object. Always list.