Objek Membership Plan

Atribut

• membership_plan_id string wajib

  Pengidentifikasi unik untuk paket keanggotaan.

• facility_id string salah satuBerikan jenis pengidentifikasi fasilitas yang dikonfigurasi untuk integrasi Anda: gunakan facility_id untuk integrasi direct-link, atau linking_identifier untuk integrasi linking-identifier. Jangan kirim keduanya; API menggunakan jenis pengidentifikasi yang dikonfigurasi untuk akun mitra Anda dan mengabaikan yang lainnya. Pelajari lebih lanjut

  Pengidentifikasi unik fasilitas dari Performance Hub.

• linking_identifier string salah satuBerikan jenis pengidentifikasi fasilitas yang dikonfigurasi untuk integrasi Anda: gunakan facility_id untuk integrasi direct-link, atau linking_identifier untuk integrasi linking-identifier. Jangan kirim keduanya; API menggunakan jenis pengidentifikasi yang dikonfigurasi untuk akun mitra Anda dan mengabaikan yang lainnya. Pelajari lebih lanjut

  Nilai pengidentifikasi unik untuk setiap lokasi yang digunakan mitra (misalnya, "Branch ID", "Location Code", "Store Number"). Pelajari lebih lanjut

• name string wajib

  Nama paket yang mudah dibaca (misalnya, "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

• billing_cycle string opsional

  Frekuensi penagihan. Salah satu dari weekly, fortnightly, monthly, annually, atau one_time.

• price integer opsional

  Biaya dasar dalam satuan mata uang terkecil (sen untuk USD/AUD).

• currency string opsional

  Kode mata uang ISO 4217 (misalnya, "AUD", "USD").

• description string opsional

  Deskripsi pemasaran atau internal opsional.

• active_members integer opsional

  Jumlah anggota aktif yang menggunakan paket keanggotaan ini

• is_recurring boolean opsional

  Apakah paket diperpanjang secara otomatis.

• is_trial boolean opsional

  Apakah ini merupakan penawaran uji coba.

• visible_to_public boolean opsional

  Apakah paket tersedia untuk pembelian mandiri.

• duration_days integer opsional

  Jumlah hari masa berlaku paket keanggotaan.

• access_zones array opsional

  Array zona akses yang termasuk dalam paket keanggotaan. Setiap zona dapat menentukan jam aksesnya sendiri. Lihat Zona Akses untuk detailnya.

• class_limit integer opsional

  Jumlah maksimum kelas yang diizinkan (null untuk tanpa batas).

Objek Membership Plan

Contoh ini menggunakan facility_id. Untuk integrasi linking-identifier, kirimkan "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
}