Đối tượng Membership Plan

Thuộc tính

• membership_plan_id string bắt buộc

  Mã định danh duy nhất của gói hội viên.

• facility_id string một trong haiCung cấp loại mã định danh cơ sở được cấu hình cho tích hợp của bạn: dùng facility_id cho tích hợp liên kết trực tiếp, hoặc linking_identifier cho tích hợp dùng mã định danh liên kết. Không gửi cả hai; API sử dụng loại mã định danh được cấu hình cho tài khoản đối tác của bạn và bỏ qua loại còn lại. Tìm hiểu thêm

  Mã định danh duy nhất của cơ sở trong Performance Hub.

• linking_identifier string một trong haiCung cấp loại mã định danh cơ sở được cấu hình cho tích hợp của bạn: dùng facility_id cho tích hợp liên kết trực tiếp, hoặc linking_identifier cho tích hợp dùng mã định danh liên kết. Không gửi cả hai; API sử dụng loại mã định danh được cấu hình cho tài khoản đối tác của bạn và bỏ qua loại còn lại. Tìm hiểu thêm

  Giá trị mã định danh duy nhất mà đối tác dùng cho từng địa điểm (ví dụ: "Branch ID", "Location Code", "Store Number"). Tìm hiểu thêm

• name string bắt buộc

  Tên gói dễ đọc (ví dụ: "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

• billing_cycle string tùy chọn

  Tần suất thanh toán. Một trong các giá trị weekly, fortnightly, monthly, annually hoặc one_time.

• price integer tùy chọn

  Chi phí cơ bản tính theo đơn vị tiền tệ nhỏ nhất (cent đối với USD/AUD).

• currency string tùy chọn

  Mã tiền tệ ISO 4217 (ví dụ: "AUD", "USD").

• description string tùy chọn

  Mô tả tiếp thị hoặc mô tả nội bộ không bắt buộc.

• active_members integer tùy chọn

  Số hội viên đang hoạt động sử dụng gói hội viên này

• is_recurring boolean tùy chọn

  Gói có tự động gia hạn hay không.

• is_trial boolean tùy chọn

  Đây có phải là gói dùng thử hay không.

• visible_to_public boolean tùy chọn

  Gói có thể được tự mua hay không.

• duration_days integer tùy chọn

  Số ngày gói hội viên có hiệu lực.

• access_zones array tùy chọn

  Mảng các khu vực ra vào có trong gói hội viên. Mỗi khu vực có thể xác định giờ ra vào riêng. Xem Khu vực ra vào để biết chi tiết.

• class_limit integer tùy chọn

  Số lớp học tối đa được phép (null nếu không giới hạn).

Đối tượng Membership Plan

Ví dụ này sử dụng facility_id. Đối với tích hợp dùng mã định danh liên kết, hãy gửi "linking_identifier": "branch_downtown" thay thế.

{
  "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
}