Het Membership Plan-object

Attributen

• membership_plan_id string verplicht

  Unieke identificatie van het abonnement.

• facility_id string een van beideGeef het type faciliteitidentificatie op dat voor je integratie is geconfigureerd: gebruik facility_id voor integraties met Direct Link of linking_identifier voor integraties met een Linking Identifier. Stuur ze niet allebei: de API gebruikt het identificatietype dat voor je partneraccount is geconfigureerd en negeert het andere. Meer informatie

  Unieke identificatie van de faciliteit uit Performance Hub.

• linking_identifier string een van beideGeef het type faciliteitidentificatie op dat voor je integratie is geconfigureerd: gebruik facility_id voor integraties met Direct Link of linking_identifier voor integraties met een Linking Identifier. Stuur ze niet allebei: de API gebruikt het identificatietype dat voor je partneraccount is geconfigureerd en negeert het andere. Meer informatie

  Unieke identificatiewaarde die de partner voor elke locatie gebruikt (bijvoorbeeld "Branch ID", "Location Code", "Store Number"). Meer informatie

• name string verplicht

  Leesbare naam van het abonnement (bijvoorbeeld "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

• billing_cycle string optioneel

  Factureringsfrequentie. Een van weekly, fortnightly, monthly, annually of one_time.

• price integer optioneel

  Basisprijs in de kleinste munteenheid (centen voor USD/AUD).

• currency string optioneel

  ISO 4217-valutacode (bijvoorbeeld "AUD", "USD").

• description string optioneel

  Optionele marketing- of interne beschrijving.

• active_members integer optioneel

  Aantal actieve leden met dit abonnement

• is_recurring boolean optioneel

  Of het abonnement automatisch wordt verlengd.

• is_trial boolean optioneel

  Of dit een proefaanbod is.

• visible_to_public boolean optioneel

  Of het abonnement via selfservice kan worden gekocht.

• duration_days integer optioneel

  Aantal dagen dat het abonnement geldig is.

• access_zones array optioneel

  Array van toegangszones die in het abonnement zijn inbegrepen. Elke zone kan eigen toegangsuren definiëren. Zie Toegangszones voor meer informatie.

• class_limit integer optioneel

  Maximaal toegestaan aantal lessen (null voor onbeperkt).

Het Membership Plan-object

Dit voorbeeld gebruikt facility_id. Stuur voor een integratie met een Linking Identifier in plaats daarvan "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
}