सदस्यता प्लान ऑब्जेक्ट

एट्रिब्यूट

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
}