멤버십 플랜 객체

속성

  • 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).

멤버십 플랜 객체

이 예시에서는 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
}