Sample - Stripe API
GET/v1/payment_links

List all payment links

Lists payment links available to the authenticated user. Use active to filter by activation state and starting_after or ending_before to navigate the cursor-paginated results. Use limit to control the page size.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

5 parameters
activebooleanoptional
Filter payment links by whether they are active or inactive.
ending_beforestringoptional
Pagination cursor identifying the payment link before which to return results. Maximum 5000 characters.
expandarray<string>optional
Fields to expand in each returned payment link; each expansion name can be no longer than 5000 characters.
limitintegeroptional
Maximum number of payment links to return. Must be between 1 and 100, and defaults to 10 when omitted.
starting_afterstringoptional
Pagination cursor identifying the payment link after which to return results. Maximum 5000 characters.

2 status codes
200Returns a paginated list object containing payment links in `data`, a `has_more` pagination flag, the list `object` value, and the request `url`.
dataarray<PaymentLink>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Allowed:list
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired

Error handling

limit must be between 1 and 100 and defaults to 10 when omitted. active filters links by activation state, while starting_after and ending_before must contain payment link object IDs no longer than 5000 characters. Each expand value must be no longer than 5000 characters.