List all Payment Links

Returns a list of your payment links.

You can also create and manage payment links in the Merchant Dashboard.

Related guide: Payment Links

Query Parameters

account_id
Type: array string[]
start_date
Type: string Format: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
end_date
Type: string Format: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
status
Type: array string[]
currency
Type: array string[]
limit
Type: integer

Integer numbers.
last_key
Type: string

Opaque cursor for pagination. Use the last_key value from the previous response to retrieve the next page.
client_reference_id
Type: string

A free-form reference to identify the transaction in your system. This field will override other parameters except start and end dates.
id
Type: string

Responses

application/json
application/json
application/json
application/json
application/json

get/v1/payment-links

curl https://api.paypercut.io/v1/payment-links \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "items": [
    {
      "amount": 2000,
      "on_behalf_of": "string",
      "payment_method_configuration": null,
      "expires_at": "2026-07-08T08:02:27.743Z",
      "line_items": [
        {
          "quantity": 2,
          "price": "01K755J9SV2364REVHB915Z2FW",
          "price_data": {
            "active": true,
            "billing_scheme": "per_unit",
            "created": 1,
            "currency": "string",
            "livemode": true,
            "lookup_key": null,
            "product": "01K755J9SV2364REVHB915Z2FW",
            "product_data": {
              "active": true,
              "name": "string",
              "description": "string",
              "unit_label": "string",
              "id": "string"
            },
            "recurring": {
              "interval": "daily",
              "interval_count": 1,
              "meter": null,
              "usage_type": "licensed"
            },
            "type": "one_time",
            "unit_amount": null,
            "unit_amount_decimal": null,
            "id": "string"
          },
          "metadata": {
            "additionalProperty": "string"
          }
        }
      ],
      "redirect_url": null,
      "client_reference_id": null,
      "client_customer_id": null,
      "description": null,
      "livemode": true,
      "after_completion": {
        "type": "redirect",
        "redirect": {
          "url": "https://example.com"
        },
        "hosted": {
          "custom_message": "string"
        }
      },
      "mode": "payment",
      "restrictions": {
        "completed_sessions": {
          "count": 1,
          "limit": 1
        }
      },
      "id": "string",
      "created": "2026-07-08T08:02:27.743Z",
      "currency": {
        "iso": "usd",
        "scale": 2
      },
      "active": true,
      "status": "string",
      "url": "string",
      "locale": "auto"
    }
  ],
  "last_key": "string"
}

List of payment links