Membership Plan nesnesi

Öznitelikler

  • membership_plan_id string zorunlu

    Üyelik planının benzersiz tanımlayıcısı.

  • facility_id string ikisinden biriEntegrasyonunuz için yapılandırılmış tesis tanımlayıcısı türünü sağlayın: doğrudan bağlantı (direct-link) entegrasyonları için facility_id, bağlama tanımlayıcısı (linking-identifier) entegrasyonları için linking_identifier kullanın. İkisini birden göndermeyin; API, iş ortağı hesabınız için yapılandırılmış tanımlayıcı türünü kullanır ve diğerini yok sayar. Daha fazla bilgi

    Performance Hub'daki tesisin benzersiz tanımlayıcısı.

  • linking_identifier string ikisinden biriEntegrasyonunuz için yapılandırılmış tesis tanımlayıcısı türünü sağlayın: doğrudan bağlantı (direct-link) entegrasyonları için facility_id, bağlama tanımlayıcısı (linking-identifier) entegrasyonları için linking_identifier kullanın. İkisini birden göndermeyin; API, iş ortağı hesabınız için yapılandırılmış tanımlayıcı türünü kullanır ve diğerini yok sayar. Daha fazla bilgi

    İş ortağının her konum için kullandığı benzersiz tanımlayıcı değeri (ör. "Branch ID", "Location Code", "Store Number"). Daha fazla bilgi

  • name string zorunlu

    İnsan tarafından okunabilir plan adı (ör. "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

  • billing_cycle string isteğe bağlı

    Faturalandırma sıklığı. weekly, fortnightly, monthly, annually veya one_time değerlerinden biri.

  • price integer isteğe bağlı

    En küçük para birimi cinsinden temel maliyet (USD/AUD için sent).

  • currency string isteğe bağlı

    ISO 4217 para birimi kodu (ör. "AUD", "USD").

  • description string isteğe bağlı

    İsteğe bağlı pazarlama veya dahili açıklama.

  • active_members integer isteğe bağlı

    Bu üyelik planını kullanan etkin üye sayısı

  • is_recurring boolean isteğe bağlı

    Planın otomatik olarak yenilenip yenilenmediği.

  • is_trial boolean isteğe bağlı

    Bunun bir deneme teklifi olup olmadığı.

  • visible_to_public boolean isteğe bağlı

    Planın self servis satın alma için kullanılabilir olup olmadığı.

  • duration_days integer isteğe bağlı

    Üyelik planının geçerli olduğu gün sayısı.

  • access_zones array isteğe bağlı

    Üyelik planına dahil olan erişim alanlarının dizisi. Her alan kendi erişim saatlerini tanımlayabilir. Ayrıntılar için Erişim alanları bölümüne bakın.

  • class_limit integer isteğe bağlı

    İzin verilen maksimum ders sayısı (sınırsız için null).

Membership Plan nesnesi

Bu örnek facility_id kullanır. Bağlama tanımlayıcısı entegrasyonu için bunun yerine "linking_identifier": "branch_downtown" gönderin.

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