האובייקט 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
}