حفظ خطة عضوية
ينشئ سجلات خطط العضوية أو يحدّثها. وتحدد API ما إذا كانت ستُنشئ السجل أو تحدّثه بناءً على membership_plan_id.
المعلمات
-
membership_plans
arrayمطلوبمصفوفة من كائنات خطط العضوية المراد حفظها. الحد الأقصى الموصى به: 1000 عنصر لكل طلب لتحقيق أفضل أداء. تقسّم API العناصر إلى دفعات تلقائيًا لمعالجتها. يجب أن يتضمن كل عنصر إما
facility_id(مطلوب إذا لم تستخدمlinking_identifier) أوlinking_identifier(مطلوب إذا لم تستخدمfacility_id).
القيم المُرجعة
يُرجع رسالة بسيطة تؤكد عملية المزامنة.
الطلب
يستخدم هذا المثال facility_id. وفي تكامل معرّف الربط، أرسل بدلًا من ذلك "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
}
]
}'
الاستجابة
يُرجع رسالة نجاح مع بيانات وصفية حول عملية المزامنة.
{
"message": "Membership plan sync successful.",
"metadata": {
"success": 98,
"skipped": 2,
"skipped_items": [
{
"membership_plan_id": "plan_456",
"facility_id": null,
"reason": "Missing facility_id"
}
]
}
}
حقول البيانات الوصفية:
- success - عدد خطط العضوية التي عولجت بنجاح
- skipped - عدد الخطط التي تم تخطيها (إن وجدت)
- skipped_items - مصفوفة من الخطط التي تم تخطيها مع أسباب ذلك (إن وجدت)
- dry-run - علامة منطقية عند استخدام نوع المفتاح dryrun (إن انطبق ذلك)