List Subscribers

Returns all clients attached to a subscription plan, with pagination and optional filters by status and email substring.

Use the status filter to focus on a billing state — for example, active for currently billed clients, pending for those awaiting first payment, or inactive for paused subscribers. See subscriber statuses.

GET/api/subscriptions/%plan_id%/usersAuth: Required

Query Parameters

pagenumber

Page number. Default 1.

perPagenumber

Items per page. Default 10.

More attributes

Response

pagenumber

Current page number.

perPagenumber

Items per page.

totalItemsnumber

Total subscribers matching the filter.

totalPagesnumber

Total pages available.

dataarray

List of subscriber objects, each containing id, email, status, subscribedDate, renewalDate, revenueAmount, revenueAsset, createdAt, updatedAt.

GET/api/subscriptions/%plan_id%/users

curl -G 'https://my.solopayment.com/api/subscriptions/%plan_id%/users' \
  -H 'Authorization: Bearer YOUR_PUBLIC_TOKEN' \
  --data-urlencode 'page=1' \
  --data-urlencode 'perPage=10' \
  --data-urlencode 'status=active'

EXAMPLE RESPONSE

{
  "page": 1,
  "perPage": 10,
  "totalItems": 1,
  "totalPages": 1,
  "data": [
    {
      "id": "user-uuid",
      "email": "alice@example.com",
      "status": "active",
      "subscribedDate": "2026-05-29T10:00:00.000Z",
      "renewalDate": "2026-06-29T10:00:00.000Z",
      "revenueAmount": "100.00",
      "revenueAsset": "eur",
      "createdAt": "2026-05-29T10:00:00.000Z",
      "updatedAt": "2026-05-29T10:00:00.000Z"
    }
  ]
}