v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB
Payment Links API

List payment links

Retrieve a list of all payment links.

The results are paginated.

🔑 Access with

API key

Advanced access token with payment-links.read

OAuth access with payment-links.read

get/payment-links

Query parameters

fromstring
Example:pl_d9fQur83kFdhH8hIhaZfq

Provide an ID to start the result set from the item with the given ID and onwards. This allows you to paginate the result set.

limitinteger nullable
Example:50

The maximum number of items to return. Defaults to 50 items.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

A list of payment link objects.