Skip to main content
GET
List payment links
Each link comes with totalProductsPrice: the current catalog price of its products times their quantities. Filter by a text in the name, by status and by the creation date (startAt/endAt, each on its own or both). Sort with order and orderBy, and page with limit + next: pass the next of one page to get the following one — the last page has no next. Any member of the organization, or an admin of the realm, can list them.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of your organization: the one that sells through the links.

Format: UUID

Query Parameters

name
string

Only links whose name contains this text, ignoring case.

Required string length: 1 - 56
status
enum<string>[]

Only links in these statuses. Omit it for every status.


Example (comma-separated list): ?status=ACTIVE,DEACTIVATED

Available options:
ACTIVE,
DEACTIVATED,
EXPIRED
limit
integer
default:15

Page size.

Required range: 1 <= x <= 100
next
string

Cursor returned as next by the previous page; it must be valid base64. Omit it for the first page. Use it with the same filters and order: a cursor that no longer matches a link returns the first page.

Maximum string length: 128
Pattern: ^[A-Za-z0-9+/]+={0,2}$
order
enum<string>
default:DESC

Sort direction.

Available options:
ASC,
DESC
orderBy
enum<string>
default:createdAt

Field to sort by.

Available options:
name,
createdAt
startAt

Only links created on or after this moment: an ISO 8601 date (read as midnight UTC) or a date-time with an offset.

endAt

Only links created on or before this moment: an ISO 8601 date (read as midnight UTC) or a date-time with an offset.

Response

Successful response

One page of payment links.

items
object[]
required

The links of this page.

next
string

Cursor of the next page: pass it as next to get it. Absent on the last page.

Example:

"NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy"