ออบเจ็กต์ 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
}