ออบเจ็กต์ Membership Plan

แอตทริบิวต์

  • membership_plan_id string จำเป็น

    ตัวระบุเฉพาะของแผนสมาชิก

  • facility_id string อย่างใดอย่างหนึ่งระบุประเภทตัวระบุสถานที่ที่กำหนดค่าไว้สำหรับการผสานรวมของคุณ: ใช้ facility_id สำหรับการผสานรวมแบบ Direct Link หรือใช้ linking_identifier สำหรับการผสานรวมแบบ Linking Identifier อย่าส่งทั้งสองค่า API จะใช้ประเภทตัวระบุที่กำหนดค่าไว้สำหรับบัญชีพาร์ทเนอร์ของคุณและละเว้นอีกค่าหนึ่ง ดูข้อมูลเพิ่มเติม

    ตัวระบุเฉพาะของสถานที่จาก Performance Hub

  • linking_identifier string อย่างใดอย่างหนึ่งระบุประเภทตัวระบุสถานที่ที่กำหนดค่าไว้สำหรับการผสานรวมของคุณ: ใช้ facility_id สำหรับการผสานรวมแบบ Direct Link หรือใช้ 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 หมายถึงไม่จำกัด)

ออบเจ็กต์ Membership Plan

ตัวอย่างนี้ใช้ 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
}