انتقل إلى المحتوى الرئيسي

cancelSubscription

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

الوصف​

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

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

.cancelSubscription(

);

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

المخطط

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

{ marker: "premium" }

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

أمثلة​

مثال بسيط​

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

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

{
"statusCode": 404,
"timestamp": "2026-09-25T17:23:33.051Z",
"message": "No subscription found"
}

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

Details

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