Sign in
MembershipTypes

List MembershipTypes

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

get/customers/membership-types

Query parameters

brand_idstring

Filters membership types that are associated with the given brand ID

site_idstring

Filters membership types that are associated with the given site ID

archivedboolean

Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.

publicboolean

When true, only public membership types are returned

auto_paymentsboolean

When true, only membership types that support automatic payments are returned

termsboolean

When true, only membership types that have terms and conditions are returned

querystring

Filters membership types with a similar name to the given value

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The MembershipTypes were successfully retrieved

Example response

{
  "data": [
    {
      "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.