v1

latestOpenAPI 3.0.02026-07-2673188210.8 KB
host

Get available host memberships

get/api/v2/host/memberships

Query parameters

pageinteger required

Starts at 0

pageSizeinteger required
Example:10
sortOrder'ASC' | 'DESC'
sortBy'name' | 'orderNumber'

Field to sort by

includeDisabledboolean
onlyFeaturedboolean
compatibleWithSessionIdinteger
compatibleWithAppointmentIdinteger

Response

Example response

{
  "pagination": {
    "pageSize": 10,
    "totalCount": 1
  },
  "payload": [
    {
      "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,
      "startDate": "2022-01-01T00:00:00Z",
      "endDate": "2022-02-01T00:00:00Z",
      "priceType": "fixed-price",
      "price": 955,
      "priceIncludesTax": true,
      "taxRateInPercent": 20,
      "freeTrialPrice": 199,
      "tags": [
        {
          "id": 1,
          "name": "VIP",
          "badgeLabel": "VIP",
          "badgeColor": "#fe0000",
          "corporateTagId": 1
        }
      ]
    }
  ]
}