会員プランオブジェクト

属性

membership_plan_id string 必須

会員プランの一意の識別子。
facility_id string いずれか一方連携に設定されている施設識別子の種類を指定してください。Direct Link の連携では facility_id を、Linking Identifier の連携では linking_identifier を使用します。両方を送信しないでください。API はパートナーアカウントに設定された識別子の種類を使用し、もう一方は無視します。詳細

Performance Hub での施設の一意の識別子。
linking_identifier string いずれか一方連携に設定されている施設識別子の種類を指定してください。Direct Link の連携では facility_id を、Linking Identifier の連携では 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 の連携の場合は、代わりに "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
}