Getting a list of subscribers

Sometimes you need to fetch a list of current/past subscribers to do custom reporting or sync customers based on Plan rather than inspecting each individual member.

This endpoint is paginated, see the API overview for info on how to paginate results.

Parameters

These parameters can be passed in the query string to control which subscriptions are returned in the response.

filter
Allows you to specify which subscriptions should be listed.
Defaults to active if not specified.

Possible values

active
Current and paid. May include subscriptions that will not autorenew.
inactive
Only subscriptions that have expired or been disabled. See section below on expired subscriptions.
will_not_renew
Currently active, but will not renew at the end of the current period.
trialling
List subscriptions that are active, and on a free trial. These subscriptions may have autorenew disabled.
all
List all subscriptions, regardless of their status.

Request

GET https://yoursite.memberful.com/admin/plans/1/subscribers.json?auth_token=XXXXXX&filter=active
Accept: application/json

Response

{
  "subscriptions": [
    {
      "active": true,
      "created_at": 1402281249,
      "expires": true,
      "expires_at": 1433817249,
      "id": 0,
      "in_trial_period": false,
      "member": {
        "address": {
          "street": "Street",
          "city": "City",
          "postal_code": "Postal code",
          "country": "City"
        },
        "created_at": 1508168895,
        "credit_card": {
          "exp_month": 1,
          "exp_year": 2040
        },
        "custom_field": "Custom field value",
        "email": "john.doe@example.com",
        "first_name": "John",
        "full_name": "John Doe",
        "id": 0,
        "last_name": "Doe",
        "phone_number": "555-12345",
        "stripe_customer_id": "cus_00000",
        "unrestricted_access": false,
        "username": "john_doe"
      },
      "plan": {
        "id": 0,
        "price": 1000,
        "name": "Sample plan",
        "slug": "0-sample-plan",
        "renewal_period": "monthly",
        "interval_unit": "month",
        "interval_count": 1,
        "for_sale": true
      },
      "renew_at_end_of_period": true,
      "trial_end_at": null,
      "trial_start_at": null
    }
  ]
}

If no subscriptions are matched by the filter then the subscriptions key in the response will point to an empty array, i.e.:

{
  "subscriptions": [

  ]
}

Inactive subscriptions

Subscriptions can be Inactive for a number of reasons:

General

How to

CMS Integrations

Email Newsletters

Discussion Forums

WordPress

Video

API