كائن خطة العضوية

السمات

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