List Payment Links — GET /payment-links

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

page

integer

default:"1"

Page number (1-based).

limit

integer

default:"25"

Items per page (max 100).

sort

string

Sort column: id, label, amount, uses, status, or created_at.

order

string

default:"desc"

asc or desc.

filter_id

string

Exact payment link ID.

filter_label

string

Substring match on the label.

filter_status

string

Comma-separated: active, inactive.

amount_min

number

Minimum amount.

amount_max

number

Maximum amount.

start_date

string

ISO date string — return links created on or after this date (e.g. 2026-01-01).

end_date

string

ISO date string — return links created before this date.

Response

items

array

The payment links on this page (each: id, label, amount, currency, uses, is_active, created_at).

total

integer

Total matching links.

page

integer

Current page.

limit

integer

Page size.

total_pages

integer

Total number of pages.

curl "https://api.blockra.io/payment-links?limit=10&filter_status=active" \
  -H "X-API-Key: bk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "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
}

​Request

​Query parameters

​Response

Request

Query parameters

Response