v1

latestOpenAPI 3.1.02026-07-2684271522.2 KB

Payment Links

List Payment Links

Returns a list of your payment links. Only active links are returned; archived (inactive) links are omitted. Results are ordered by ID descending. Supports cursor pagination via starting_after/ending_before; offset is deprecated. Line items and discounts are not expanded here — retrieve a single link to load them.

get/v1/payment_links

Query parameters

limitinteger nullable

Maximum number of payment links to return

Example:10

Maximum number of payment links to return

offsetinteger nullable

Number of payment links to skip (deprecated, use cursor pagination)

Example:3

Number of payment links to skip (deprecated, use cursor pagination)

starting_afterstring nullable

Cursor for pagination - return payment links after this ID

Example:fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Cursor for pagination - return payment links after this ID

ending_beforestring nullable

Cursor for pagination - return payment links before this ID

Example:fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA

Cursor for pagination - return payment links before this ID

Response

An envelope wrapping a list of payment link objects.

Example response

{
  "payment_links": [
    {
      "payment_link_id": "fplink_01J9XR8M3K7VZ8N2YB4WJ6T0RA",
      "label": "Example",
      "active": false,
      "allow_promotion_codes": false,
      "shipping_address_collection": false,
      "metadata": {
        "order_id": "8842",
        "channel": "shopify"
      },
      "url": "https://example.com",
      "created_at": "2026-06-15T14:30:00Z",
      "after_completion": {},
      "setup_future_use": "on_session",
      "test_mode": false
    }
  ]
}