Enregistrer une formule d'abonnement

Crée ou met à jour des fiches de formules d'abonnement. L'API détermine s'il faut créer ou mettre à jour la fiche en fonction du membership_plan_id.

Paramètres

membership_plans array obligatoire

Tableau d'objets Membership Plan à enregistrer. Maximum recommandé : 1000 éléments par requête pour des performances optimales. L'API regroupe automatiquement les éléments en lots pour leur traitement. Chaque élément doit inclure soit facility_id (obligatoire si vous n'utilisez pas linking_identifier), soit linking_identifier (obligatoire si vous n'utilisez pas facility_id).

Valeur renvoyée

Renvoie un message simple confirmant l'opération de synchronisation.

Requête

Cet exemple utilise facility_id. Pour une intégration à identifiant de liaison, envoyez plutôt "linking_identifier": "branch_downtown".

curl -X POST https://partner-api.performancehub.co/partner/v1/membership-plans \
  -u sk_live_YOUR_PARTNER_SECRET_KEY: \
  -H "Content-Type: application/json" \
  -d '{
    "membership_plans": [
      {
        "membership_plan_id": "plan_99999",
        "facility_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Student – term access",
        "description": "Library and student hub access for one teaching term",
        "billing_cycle": "one_time",
        "price": 4500,
        "currency": "AUD",
        "duration_days": 84,
        "is_recurring": false,
        "is_trial": false,
        "visible_to_public": true,
        "active_members": 245,
        "access_zones": [
          {
            "name": "Library",
            "description": "Reading rooms, study spaces and bookable rooms",
            "access_hours": {
              "mon": [["08:00", "21:00"]],
              "tue": [["08:00", "21:00"]],
              "wed": [["08:00", "21:00"]],
              "thu": [["08:00", "21:00"]],
              "fri": [["08:00", "17:00"]],
              "sat": [["09:00", "13:00"]]
            }
          },
          {
            "name": "Student Hub",
            "description": "Common room, kitchen and lockers",
            "access_hours": {
              "mon": [["07:00", "22:00"]],
              "tue": [["07:00", "22:00"]],
              "wed": [["07:00", "22:00"]],
              "thu": [["07:00", "22:00"]],
              "fri": [["07:00", "22:00"]]
            }
          }
        ],
        "class_limit": null
      }
    ]
  }'

Réponse

Renvoie un message de réussite accompagné de métadonnées sur l'opération de synchronisation.

{
  "message": "Membership plan sync successful.",
  "metadata": {
    "success": 98,
    "skipped": 2,
    "skipped_items": [
      {
        "membership_plan_id": "plan_456",
        "facility_id": null,
        "reason": "Missing facility_id"
      }
    ]
  }
}

Champs de métadonnées :

success - Nombre de formules d'abonnement traitées avec succès
skipped - Nombre de formules ignorées (le cas échéant)
skipped_items - Tableau des formules ignorées, avec leurs motifs (le cas échéant)
dry-run - Indicateur booléen en cas d'utilisation d'une clé de type dryrun (le cas échéant)