List Payment Links

List all payment links with pagination, filtering, and sorting options.

statusesPaymentLinkStatus[] nullable

Filter by subscription status

from_datestring date-time nullable

datetime is created_at

to_datestring date-time nullable

datetime is created_at

number

OR

string

limit list by min payment link total amount inclusive

number

OR

string

limit list by max payment link total amount inclusive

product_idsstring[] nullable

Product ids that need to be in the list of payment links

currenciesstring nullable

Filter by currency codes (OR). E.g. currencies=SAR,USD

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

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"
      }
    }
  ]
}

List Payment Links

Query parameters

Response

Example response

Changes