L'objet Membership Plan

Attributs

  • membership_plan_id string obligatoire

    Identifiant unique de la formule d'abonnement.

  • facility_id string l'un ou l'autreIndiquez le type d'identifiant d'installation configuré pour votre intégration : utilisez facility_id pour les intégrations à liaison directe, ou linking_identifier pour les intégrations à identifiant de liaison. N'envoyez pas les deux ; l'API utilise le type d'identifiant configuré pour votre compte partenaire et ignore l'autre. En savoir plus

    Identifiant unique de l'installation dans Performance Hub.

  • linking_identifier string l'un ou l'autreIndiquez le type d'identifiant d'installation configuré pour votre intégration : utilisez facility_id pour les intégrations à liaison directe, ou linking_identifier pour les intégrations à identifiant de liaison. N'envoyez pas les deux ; l'API utilise le type d'identifiant configuré pour votre compte partenaire et ignore l'autre. En savoir plus

    Valeur d'identifiant unique que le partenaire utilise pour chaque site (par exemple, « Branch ID », « Location Code », « Store Number »). En savoir plus

  • name string obligatoire

    Nom lisible de la formule (par exemple, "Office tenant – business hours", "Student – term access", "Hotel guest", "10 Class Pack").

  • billing_cycle string facultatif

    Fréquence de facturation. L'une des valeurs weekly, fortnightly, monthly, annually ou one_time.

  • price integer facultatif

    Coût de base dans la plus petite unité monétaire (cents pour USD/AUD).

  • currency string facultatif

    Code de devise ISO 4217 (par exemple, "AUD", "USD").

  • description string facultatif

    Description marketing ou interne facultative.

  • active_members integer facultatif

    Nombre de membres actifs utilisant cette formule d'abonnement

  • is_recurring boolean facultatif

    Indique si la formule est renouvelée automatiquement.

  • is_trial boolean facultatif

    Indique s'il s'agit d'une offre d'essai.

  • visible_to_public boolean facultatif

    Indique si la formule peut être achetée en libre-service.

  • duration_days integer facultatif

    Nombre de jours de validité de la formule d'abonnement.

  • access_zones array facultatif

    Tableau des zones d'accès incluses dans la formule d'abonnement. Chaque zone peut définir ses propres heures d'accès. Consultez Zones d'accès pour plus de détails.

  • class_limit integer facultatif

    Nombre maximal de cours autorisés (null pour un nombre illimité).

L'objet Membership Plan

Cet exemple utilise facility_id. Pour une intégration à identifiant de liaison, envoyez plutôt "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
}