Add Subscribers

Attaches one or more clients (by email) to a subscription plan. Accepts a batch — each email is validated independently and the response indicates whether it was added or already existed.

A newly added subscriber starts in pending status. The first invoice is generated right away, and the subscriber receives an automated email with a payment link. Once they pay it (before it expires), the status transitions to active and the subscriber is billed on each subsequent renewal cycle. See subscriber statuses for the full status reference.

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

Request Body

usersarrayRequired

Array of user objects to add to the plan.

Response

usersarray

Array of result entries — one per email in the request, in the same order. Each entry has the original email and a status:

POST/api/subscriptions/%plan_id%/users

curl -X POST 'https://my.solopayment.com/api/subscriptions/%plan_id%/users' \
  -H 'Authorization: Bearer YOUR_PUBLIC_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '<body>'

BODY

{
  "users": [
    { "email": "alice@example.com" },
    { "email": "bob@example.com" }
  ]
}

EXAMPLE RESPONSE

{
  "users": [
    { "email": "alice@example.com", "status": "done" },
    { "email": "bob@example.com", "status": "done" },
    { "email": "alice@example.com", "status": "duplicate" }
  ]
}

Request Body​

Response​

Request Body

Response