Das Mitgliedschaftstarif-Objekt

Attribute

• membership_plan_id string erforderlich

  Eindeutige Kennung des Mitgliedschaftstarifs.

• facility_id string entweder/oderGeben Sie den für Ihre Integration konfigurierten Typ der Einrichtungskennung an: Verwenden Sie facility_id für Direct-Link-Integrationen oder linking_identifier für Linking-Identifier-Integrationen. Senden Sie nicht beide; die API verwendet den für Ihr Partnerkonto konfigurierten Kennungstyp und ignoriert den anderen. Weitere Informationen

  Eindeutige Kennung der Einrichtung aus dem Performance Hub.

• linking_identifier string entweder/oderGeben Sie den für Ihre Integration konfigurierten Typ der Einrichtungskennung an: Verwenden Sie facility_id für Direct-Link-Integrationen oder linking_identifier für Linking-Identifier-Integrationen. Senden Sie nicht beide; die API verwendet den für Ihr Partnerkonto konfigurierten Kennungstyp und ignoriert den anderen. Weitere Informationen

  Eindeutiger Kennungswert, den der Partner für jeden Standort verwendet (z. B. „Branch ID“, „Location Code“, „Store Number“). Weitere Informationen

• name string erforderlich

  Menschenlesbarer Tarifname (z. B. "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

• billing_cycle string optional

  Abrechnungshäufigkeit. Einer der Werte weekly, fortnightly, monthly, annually oder one_time.

• price integer optional

  Grundpreis in der kleinsten Währungseinheit (Cent bei USD/AUD).

• currency string optional

  Währungscode nach ISO 4217 (z. B. "AUD", "USD").

• description string optional

  Optionale Marketing- oder interne Beschreibung.

• active_members integer optional

  Anzahl der aktiven Mitglieder mit diesem Mitgliedschaftstarif

• is_recurring boolean optional

  Ob sich der Tarif automatisch verlängert.

• is_trial boolean optional

  Ob es sich um ein Testangebot handelt.

• visible_to_public boolean optional

  Ob der Tarif im Self-Service gekauft werden kann.

• duration_days integer optional

  Anzahl der Tage, die der Mitgliedschaftstarif gültig ist.

• access_zones array optional

  Array der im Mitgliedschaftstarif enthaltenen Zutrittszonen. Jede Zone kann eigene Zutrittszeiten definieren. Details finden Sie unter Zutrittszonen.

• class_limit integer optional

  Maximale Anzahl zulässiger Kurse (null für unbegrenzt).

Das Mitgliedschaftstarif-Objekt

Dieses Beispiel verwendet facility_id. Senden Sie bei einer Linking-Identifier-Integration stattdessen "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
}