Sign in
MembershipTypes

Show MembershipType

This endpoint retrieves a MembershipType by its ID.

get/customers/membership-types/{membershipTypeId}

Response

The MembershipType was 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"
  }
}

Changes

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