Объект Membership Plan

Атрибуты

  • membership_plan_id string обязательный

    Уникальный идентификатор плана членства.

  • facility_id string одно из двухУкажите тип идентификатора объекта, настроенный для вашей интеграции: facility_id для интеграций с прямой связью или linking_identifier для интеграций со связующим идентификатором. Не отправляйте оба; API использует тип идентификатора, настроенный для вашей партнерской учетной записи, и игнорирует другой. Подробнее

    Уникальный идентификатор объекта в Performance Hub.

  • linking_identifier string одно из двухУкажите тип идентификатора объекта, настроенный для вашей интеграции: facility_id для интеграций с прямой связью или linking_identifier для интеграций со связующим идентификатором. Не отправляйте оба; API использует тип идентификатора, настроенный для вашей партнерской учетной записи, и игнорирует другой. Подробнее

    Уникальное значение идентификатора каждой площадки, используемое партнером (например, "Branch ID", "Location Code", "Store Number"). Подробнее

  • name string обязательный

    Удобочитаемое название плана (например, "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

  • billing_cycle string необязательный

    Периодичность выставления счетов. Одно из значений: weekly, fortnightly, monthly, annually или one_time.

  • price integer необязательный

    Базовая стоимость в наименьшей денежной единице (центы для USD/AUD).

  • currency string необязательный

    Код валюты ISO 4217 (например, "AUD", "USD").

  • description string необязательный

    Необязательное маркетинговое или внутреннее описание.

  • active_members integer необязательный

    Количество активных участников, использующих этот план членства

  • is_recurring boolean необязательный

    Продлевается ли план автоматически.

  • is_trial boolean необязательный

    Является ли предложение пробным.

  • visible_to_public boolean необязательный

    Доступен ли план для самостоятельной покупки.

  • duration_days integer необязательный

    Количество дней действия плана членства.

  • access_zones array необязательный

    Массив зон доступа, входящих в план членства. Для каждой зоны можно задать собственные часы доступа. Подробнее см. в разделе Зоны доступа.

  • class_limit integer необязательный

    Максимальное разрешенное количество занятий (null — без ограничений).

Объект Membership Plan

В этом примере используется facility_id. Для интеграции со связующим идентификатором отправьте вместо него "linking_identifier": "branch_downtown".

{
  "membership_plan_id": "plan_99999",
  "facility_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Office tenant – business hours",
  "description": "Weekday access to the level 3 tenancy and the end-of-trip facilities",
  "billing_cycle": "monthly",
  "price": 8900,
  "currency": "AUD",
  "duration_days": 30,
  "is_recurring": true,
  "is_trial": false,
  "visible_to_public": false,
  "active_members": 245,
  "access_zones": [
    {
      "name": "Level 3 Tenancy",
      "description": "Lift lobby, offices and meeting rooms on level 3",
      "access_hours": {
        "mon": [["07:00", "19:00"]],
        "tue": [["07:00", "19:00"]],
        "wed": [["07:00", "19:00"]],
        "thu": [["07:00", "19:00"]],
        "fri": [["07:00", "19:00"]]
      }
    },
    {
      "name": "End-of-trip Facilities",
      "description": "Bike storage, lockers and showers",
      "access_hours": {
        "mon": [["06:00", "20:00"]],
        "tue": [["06:00", "20:00"]],
        "wed": [["06:00", "20:00"]],
        "thu": [["06:00", "20:00"]],
        "fri": [["06:00", "20:00"]]
      }
    }
  ],
  "class_limit": null
}