Skip to main content
GET
List checkout 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
required

Required. Filters to checkout links for this clinic

clinic_client_id
integer | null

When provided, filters to checkout links for this clinic client

start_date__gte
string | null

When provided, filters to checkout links sent on or after this date. This will be translated to a datetime representing the start of the day in the clinic's timezone. Format: YYYY-MM-DD

end_date__lte
string | null

When provided, filters to checkout links sent on or prior to this date. This will be translated to a datetime representing the end of the day in the clinic's timezone. Format: YYYY-MM-DD

Response

200 - application/json

OK

data
ExternalCheckoutLinkSchema · 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.