Objek Pelan Keahlian

Atribut

• membership_plan_id string wajib

  Pengecam unik bagi pelan keahlian.

• facility_id string salah satuBerikan jenis pengecam kemudahan yang dikonfigurasikan untuk integrasi anda: gunakan facility_id untuk integrasi Direct Link, atau linking_identifier untuk integrasi Linking Identifier. Jangan hantar kedua-duanya; API menggunakan jenis pengecam yang dikonfigurasikan untuk akaun rakan kongsi anda dan mengabaikan yang satu lagi. Ketahui lebih lanjut

  Pengecam unik kemudahan daripada Performance Hub.

• linking_identifier string salah satuBerikan jenis pengecam kemudahan yang dikonfigurasikan untuk integrasi anda: gunakan facility_id untuk integrasi Direct Link, atau linking_identifier untuk integrasi Linking Identifier. Jangan hantar kedua-duanya; API menggunakan jenis pengecam yang dikonfigurasikan untuk akaun rakan kongsi anda dan mengabaikan yang satu lagi. Ketahui lebih lanjut

  Nilai pengecam unik untuk setiap lokasi yang digunakan oleh rakan kongsi (contohnya, "Branch ID", "Location Code", "Store Number"). Ketahui lebih lanjut

• name string wajib

  Nama pelan yang boleh dibaca oleh manusia (contohnya, "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

• billing_cycle string pilihan

  Kekerapan pengebilan. Salah satu daripada weekly, fortnightly, monthly, annually atau one_time.

• price integer pilihan

  Kos asas dalam unit mata wang terkecil (sen untuk USD/AUD).

• currency string pilihan

  Kod mata wang ISO 4217 (contohnya, "AUD", "USD").

• description string pilihan

  Penerangan pemasaran atau dalaman pilihan.

• active_members integer pilihan

  Bilangan ahli aktif yang menggunakan pelan keahlian ini

• is_recurring boolean pilihan

  Sama ada pelan diperbaharui secara automatik.

• is_trial boolean pilihan

  Sama ada ini ialah tawaran percubaan.

• visible_to_public boolean pilihan

  Sama ada pelan tersedia untuk pembelian layan diri.

• duration_days integer pilihan

  Bilangan hari pelan keahlian sah.

• access_zones array pilihan

  Tatasusunan zon akses yang termasuk dalam pelan keahlian. Setiap zon boleh mentakrifkan waktu aksesnya sendiri. Lihat Zon Akses untuk butiran.

• class_limit integer pilihan

  Bilangan maksimum kelas yang dibenarkan (null untuk tanpa had).

Objek Pelan Keahlian

Contoh ini menggunakan facility_id. Untuk integrasi Linking Identifier, hantar "linking_identifier": "branch_downtown" sebagai gantinya.

{
  "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
}