v1

latestOpenAPI 3.0.02026-07-2673188210.8 KB
host

Get all active subscriptions and packs of a specific member

get/api/v2/host/members/{memberId}/bought-memberships/active

Path parameters

memberIdnumber required

Query parameters

pageinteger required

Starts at 0

pageSizeinteger required
Example:10
includeFrozenboolean

Response

Example response

{
  "pagination": {
    "pageSize": 10,
    "totalCount": 1
  },
  "payload": [
    {
      "id": 1,
      "type": "subscription",
      "startDate": "2021-01-01T00:00:00Z",
      "endDate": "2021-02-01T00:00:00Z",
      "usageLimitForSessions": 5,
      "usageLimitForAppointments": 3,
      "usedSessions": 1,
      "usedAppointments": 2,
      "membership": {
        "id": 5,
        "name": "Monthly Membership",
        "description": "Monthly membership with unlimited access to <b>all</b> classes.",
        "type": "subscription",
        "autoRenewing": true,
        "duration": 1,
        "durationUnit": "months",
        "activationDeadlineInDays": 21,
        "freeTrialDurationInDays": 7,
        "contractAgreement": "Contract agreement text",
        "order": 1,
        "usageLimitForSessions": 5,
        "usageLimitForAppointments": 2
      }
    }
  ]
}