> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blockra.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Payment Links — GET /payment-links

> Page through your payment links with filters and sorting. Requires payment_links:read.

Returns a paginated list of your payment links, newest first. Requires the `payment_links:read` scope.

## Request

**`GET https://api.blockra.io/payment-links`**

### Query parameters

<ParamField query="page" default="1" type="integer">
  Page number (1-based).
</ParamField>

<ParamField query="limit" default="25" type="integer">
  Items per page (max 100).
</ParamField>

<ParamField query="sort" type="string">
  Sort column: `id`, `label`, `amount`, `uses`, `status`, or `created_at`.
</ParamField>

<ParamField query="order" default="desc" type="string">
  `asc` or `desc`.
</ParamField>

<ParamField query="filter_id" type="string">
  Exact payment link ID.
</ParamField>

<ParamField query="filter_label" type="string">
  Substring match on the label.
</ParamField>

<ParamField query="filter_status" type="string">
  Comma-separated: `active`, `inactive`.
</ParamField>

<ParamField query="amount_min" type="number">
  Minimum amount.
</ParamField>

<ParamField query="amount_max" type="number">
  Maximum amount.
</ParamField>

<ParamField query="start_date" type="string">
  ISO date string — return links created on or after this date (e.g. `2026-01-01`).
</ParamField>

<ParamField query="end_date" type="string">
  ISO date string — return links created before this date.
</ParamField>

## Response

<ResponseField name="items" type="array">
  The payment links on this page (each: `id`, `label`, `amount`, `currency`, `uses`, `is_active`, `created_at`).
</ResponseField>

<ResponseField name="total" type="integer">
  Total matching links.
</ResponseField>

<ResponseField name="page" type="integer">
  Current page.
</ResponseField>

<ResponseField name="limit" type="integer">
  Page size.
</ResponseField>

<ResponseField name="total_pages" type="integer">
  Total number of pages.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.blockra.io/payment-links?limit=10&filter_status=active" \
    -H "X-API-Key: bk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": {
      "items": [
        {
          "id": "plink_7h8i9j0k1l2m3n4o",
          "label": "Pro plan",
          "amount": 49.00,
          "currency": "USD",
          "uses": 12,
          "is_active": true,
          "created_at": "2026-07-09T02:40:00.000Z"
        }
      ],
      "total": 1,
      "page": 1,
      "limit": 10,
      "total_pages": 1
    },
    "error": null
  }
  ```
</ResponseExample>