cancelSubscription

إلغاء الاشتراك. 🔐 تتطلب هذه الطريقة التفويض.

الوصف

تقوم هذه الطريقة بإلغاء اشتراك المستخدم الحالي المحدد بواسطة علامته. تعيد Promise التي تحل إلى true إذا تم إلغاء الاشتراك، أو كائن IError إذا كانت هناك مشكلة.

⚠️ مع الإعداد الافتراضي errors.isShell: true، يتم إرجاع الطلب المرفوض بدلاً من رميه: هذه الطريقة تحل إلى كائن IError، وليس إلى false. تحقق من result === true - كائن الخطأ يعتبر صحيحًا، لذا فإن if (result) سيعتبر الفشل نجاحًا.

Subscriptions.cancelSubscription(

body*

);

مخطط المعلمات

المخطط

body(required): ICancelSubscription
نص الاشتراك
مثال:

{ marker: "premium" }

body.marker(required): string
علامة الاشتراك.
مثال: "premium"

أمثلة

مثال بسيط

const response = await Subscriptions.cancelSubscription({ marker: 'premium' });

مثال على الاستجابة

{
  "statusCode": 404,
  "timestamp": "2026-08-14T13:04:36.941Z",
  "message": "No subscription found"
}

مخطط الاستجابة

Details

المخطط: boolean

boolean: boolean
ترجع true إذا تم إلغاء الاشتراك.
مثال: true

---