会员计划对象

属性

• 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
}