Salvare un piano di abbonamento

Crea o aggiorna i record dei piani di abbonamento. L'API stabilisce se creare o aggiornare in base al membership_plan_id.

Parametri

membership_plans array obbligatorio

Array di oggetti Membership Plan da salvare. Massimo consigliato: 1000 elementi per richiesta, per prestazioni ottimali. L'API suddivide automaticamente gli elementi in batch per l'elaborazione. Ogni elemento deve includere facility_id (obbligatorio se non usi linking_identifier) oppure linking_identifier (obbligatorio se non usi facility_id).

Valore restituito

Restituisce un semplice messaggio di conferma dell'operazione di sincronizzazione.

Richiesta

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

Risposta

Restituisce un messaggio di esito positivo con i metadati dell'operazione di sincronizzazione.

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

Campi dei metadati:

success - Numero di piani di abbonamento elaborati correttamente
skipped - Numero di piani saltati (se presenti)
skipped_items - Array dei piani saltati con i relativi motivi (se presenti)
dry-run - Flag booleano presente se usi il tipo di chiave dryrun (se applicabile)