Fetch subscribers

Returns the customers subscribed to a subscription, newest first, as an array. The list is not paginated.

Each subscriber has an id (MPB-SUBSCRIBER-...), a status (Active, Paused or Unsubscribed), the customer (id CUS-..., name and email), number_of_payments (every payment attempt on this subscription, including failed and refunded ones, not only successful charges), total_paid (the sum of captured payments, as a formatted string such as AED 11.00), and next_payment_date. next_payment_date is null unless the subscriber is active.

Use the subscriber id to unsubscribe one customer or to move them to another plan.

If the subscription doesn't exist or isn't attached to a payment link, the call returns 404.

Recipes
🔁
Bill a customer every month
Open Recipe
Path Params
string
required
Defaults to MPB-SUB-3C4D5E6F7A

Subscription ID (the identifier of the subscription whose subscribers you want to list, not a subscriber ID)

Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

500

Unexpected error

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json