Einen Mitgliedschaftstarif speichern

Erstellt oder aktualisiert Datensätze zu Mitgliedschaftstarifen. Die API entscheidet anhand der membership_plan_id, ob ein Datensatz erstellt oder aktualisiert wird.

Parameter

membership_plans array erforderlich

Array der zu speichernden Mitgliedschaftstarif-Objekte. Empfohlenes Maximum für optimale Leistung: 1000 Elemente pro Anfrage. Die API fasst Elemente für die Verarbeitung automatisch in Batches zusammen. Jedes Element muss entweder facility_id (erforderlich, wenn linking_identifier nicht verwendet wird) oder linking_identifier (erforderlich, wenn facility_id nicht verwendet wird) enthalten.

Rückgabe

Gibt eine einfache Meldung zurück, die den Synchronisierungsvorgang bestätigt.

Anfrage

Dieses Beispiel verwendet facility_id. Senden Sie bei einer Linking-Identifier-Integration stattdessen "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
      }
    ]
  }'

Antwort

Gibt eine Erfolgsmeldung mit Metadaten zum Synchronisierungsvorgang zurück.

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

Metadatenfelder:

success - Anzahl der erfolgreich verarbeiteten Mitgliedschaftstarife
skipped - Anzahl der übersprungenen Tarife (falls vorhanden)
skipped_items - Array der übersprungenen Tarife mit Gründen (falls vorhanden)
dry-run - Boolesches Flag bei Verwendung des Schlüsseltyps dryrun (falls zutreffend)