Obiekt Membership Plan

Atrybuty

• membership_plan_id string wymagany

  Unikatowy identyfikator planu członkostwa.

• facility_id string jedno z dwóchPodaj typ identyfikatora obiektu skonfigurowany dla Twojej integracji: facility_id w przypadku integracji z bezpośrednim łączeniem lub linking_identifier w przypadku integracji z identyfikatorem łączącym. Nie wysyłaj obu; API używa typu identyfikatora skonfigurowanego dla Twojego konta partnera i ignoruje drugi. Więcej informacji

  Unikatowy identyfikator obiektu z Performance Hub.

• linking_identifier string jedno z dwóchPodaj typ identyfikatora obiektu skonfigurowany dla Twojej integracji: facility_id w przypadku integracji z bezpośrednim łączeniem lub linking_identifier w przypadku integracji z identyfikatorem łączącym. Nie wysyłaj obu; API używa typu identyfikatora skonfigurowanego dla Twojego konta partnera i ignoruje drugi. Więcej informacji

  Unikatowa wartość identyfikatora, której partner używa dla każdej lokalizacji (np. „Branch ID”, „Location Code”, „Store Number”). Więcej informacji

• name string wymagany

  Czytelna nazwa planu (np. "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

• billing_cycle string opcjonalny

  Częstotliwość rozliczeń. Jedna z wartości: weekly, fortnightly, monthly, annually lub one_time.

• price integer opcjonalny

  Koszt podstawowy w najmniejszej jednostce waluty (centy w przypadku USD/AUD).

• currency string opcjonalny

  Kod waluty ISO 4217 (np. "AUD", "USD").

• description string opcjonalny

  Opcjonalny opis marketingowy lub wewnętrzny.

• active_members integer opcjonalny

  Liczba aktywnych członków korzystających z tego planu członkostwa

• is_recurring boolean opcjonalny

  Określa, czy plan odnawia się automatycznie.

• is_trial boolean opcjonalny

  Określa, czy jest to oferta próbna.

• visible_to_public boolean opcjonalny

  Określa, czy plan jest dostępny do samodzielnego zakupu.

• duration_days integer opcjonalny

  Liczba dni ważności planu członkostwa.

• access_zones array opcjonalny

  Tablica stref dostępu objętych planem członkostwa. Każda strefa może definiować własne godziny dostępu. Szczegóły znajdziesz w sekcji Strefy dostępu.

• class_limit integer opcjonalny

  Maksymalna dozwolona liczba zajęć (null oznacza brak limitu).

Obiekt Membership Plan

W tym przykładzie użyto facility_id. W przypadku integracji z identyfikatorem łączącym wyślij zamiast tego "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
}