Sign in
Memberships

List Memberships

This endpoint lists the Memberships which are associated to the provided site.

By default only active (non-archived) memberships are returned. Pass archived=true to retrieve archived (soft-deleted) memberships instead.

get/customers/memberships

Query parameters

customer_idstring uuid

Filters memberships belonging to the specified customer

archivedboolean

When true, only archived (soft-deleted) memberships are returned

site_idstring

The site ID to filter against

statusstring[]

The status of the membership

membership_type_idstring uuid

Deprecated. Use membership_type_ids instead.

membership_type_idsstring[]

The membership type IDs to filter against. Separate multiple IDs with a comma.

membership_rate_idsstring[]

Restrict the result to memberships on the given membership rates. Pass one or more MembershipRate IDs separated by commas. When omitted, all rates are returned.

created_at_fromstring date

Filter memberships created no earlier than the given date

created_at_tostring date

Filter memberships created no later than the given date

next_billing_date_fromstring date

Filter memberships due for billing no earlier than the given date

next_billing_date_tostring date

Filter memberships due for billing no later than the given date

end_date_fromstring date

Filter memberships that end no earlier than the given date

end_date_tostring date

Filter memberships that end no later than the given date

attention_reasonstring

The reason why this membership needs attention

manual_paymentsboolean

Whether to only show membership types that have auto-payments disabled

billing_frequencystring[]

The membership billing frequency to filter against

rate_idstring[]

The membership rate to filter against

membership_numberstring

The membership number to filter against

external_refstring

The external reference to filter against

organisation_idstring uuid

Filter results by the given organisation ID

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The Memberships were successfully retrieved

Example response

{
  "data": [
    {
      "customer": {
        "first_name": "Jane",
        "last_name": "Doe",
        "full_name": "Jane Doe",
        "phone": "+447900000000",
        "has_password": true,
        "stripe_id": "cus_1234567890",
        "express_stripe_id": "cus_1234567890",
        "email": "janedoe@example.com",
        "labels": [
          {
            "value": "VIP",
            "colour": "ff6634"
          }
        ],
        "preferred_locale": "en",
        "last_check_in": {
          "method": "Scanned"
        },
        "avatar_id": "000000-000000-000000-000000",
        "avatar": {
          "file_name": "super-cool-photo.jpg",
          "mime_type": "image/jpeg",
          "original_url": "https://example.com/media/super-cool-photo.jpg",
          "size": 84256,
          "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
        },
        "external_ref": "ext-cust-789012"
      },
      "members": [
        {
          "membership_number": "1234567890"
        }
      ],
      "membership_number": "1234567890",
      "next_charge": {
        "amount": 3995,
        "currency": "GBP"
      },
      "payment_method": {
        "status": "revoked",
        "card_brand": "amex"
      },
      "rate": {
        "name": "Standard rate",
        "currency": "GBP",
        "price": 5000,
        "joining_fee": 1000,
        "billing_frequency": "P1M",
        "default_duration": "P1Y",
        "notice_period": "P1M",
        "private": true
      },
      "type": {
        "name": "Gold tier",
        "description": "Enjoy exclusive benefits as part of being a member in our Gold tier",
        "min_members": 2,
        "max_members": 4,
        "rates": [
          {
            "name": "Standard rate",
            "currency": "GBP",
            "price": 5000,
            "joining_fee": 1000,
            "billing_frequency": "P1M",
            "default_duration": "P1Y",
            "notice_period": "P1M",
            "private": true
          }
        ],
        "revenue_schedule": "FREQ=WEEKLY"
      }
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.