L'oggetto Membership Plan

Attributi

• membership_plan_id string obbligatorio

  Identificatore univoco del piano di abbonamento.

• facility_id string in alternativaIndica il tipo di identificatore della struttura configurato per la tua integrazione: usa facility_id per le integrazioni con collegamento diretto oppure linking_identifier per le integrazioni con identificatore di collegamento. Non inviarli entrambi: l'API usa il tipo di identificatore configurato per il tuo account partner e ignora l'altro. Scopri di più

  Identificatore univoco della struttura nel Performance Hub.

• linking_identifier string in alternativaIndica il tipo di identificatore della struttura configurato per la tua integrazione: usa facility_id per le integrazioni con collegamento diretto oppure linking_identifier per le integrazioni con identificatore di collegamento. Non inviarli entrambi: l'API usa il tipo di identificatore configurato per il tuo account partner e ignora l'altro. Scopri di più

  Valore dell'identificatore univoco che il partner usa per ogni sede (ad esempio "Branch ID", "Location Code", "Store Number"). Scopri di più

• name string obbligatorio

  Nome leggibile del piano (ad esempio "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

• billing_cycle string facoltativo

  Frequenza di fatturazione. Uno tra weekly, fortnightly, monthly, annually e one_time.

• price integer facoltativo

  Costo base nella più piccola unità della valuta (centesimi per USD/AUD).

• currency string facoltativo

  Codice valuta ISO 4217 (ad esempio "AUD", "USD").

• description string facoltativo

  Descrizione facoltativa, di marketing o interna.

• active_members integer facoltativo

  Numero di membri attivi che usano questo piano di abbonamento

• is_recurring boolean facoltativo

  Indica se il piano si rinnova automaticamente.

• is_trial boolean facoltativo

  Indica se si tratta di un'offerta di prova.

• visible_to_public boolean facoltativo

  Indica se il piano è disponibile per l'acquisto in autonomia.

• duration_days integer facoltativo

  Numero di giorni di validità del piano di abbonamento.

• access_zones array facoltativo

  Array delle zone di accesso incluse nel piano di abbonamento. Ogni zona può definire orari di accesso propri. Consulta Zone di accesso per i dettagli.

• class_limit integer facoltativo

  Numero massimo di lezioni consentite (null per un numero illimitato).

L'oggetto Membership Plan

Questo esempio usa facility_id. Per un'integrazione con identificatore di collegamento, invia invece "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
}