List Payment Links
List all payment links with pagination, filtering, and sorting options.
Query parameters
Filter by subscription status
Filter by subscription status
datetime is created_at
datetime is created_at
datetime is created_at
datetime is created_at
limit list by min payment link total amount inclusive
limit list by max payment link total amount inclusive
Product ids that need to be in the list of payment links
Product ids that need to be in the list of payment links
Filter by currency codes (OR). E.g. currencies=SAR,USD
Filter by currency codes (OR). E.g. currencies=SAR,USD
Page number, defaults to 1.
Page number, defaults to 1.
Size of a page, defaults to 10. Maximum is 100.
Size of a page, defaults to 10. Maximum is 100.
Field to sort by, e.g., 'amount', 'scheduled_on'
Field to sort by, e.g., 'amount', 'scheduled_on'
Sorting direction ('asc' or 'desc')
Sorting direction ('asc' or 'desc')
Response
Successful Response
Example response
{
"data": [
{
"custom_fields": {
"properties": {
"child_name": {
"title": "Child Name",
"type": "string"
},
"parent_email": {
"title": "Parent Email",
"type": "string"
}
},
"required": [
"child_name"
],
"type": "object"
}
}
]
}