الانتقال إلى المحتوى الرئيسي
GET
الحصول على حالة الفواتير
يعرض الحالة الصحية الحالية لفوترة المستأجر الخاص بك. استخدم نقطة النهاية هذه في تكاملك لاكتشاف مشكلات الدفع مبكرًا وعرض المطالبات لمستخدميك قبل تقييد الوصول. عندما تكون جميع المدفوعات جارية، يكون feature_mode هو NORMAL و grace_until هو null. إذا فشلت دفعة، يدخل الحساب في سير عمل وصول متدرج — متدهور، مقيد، ثم معلق — مع فترة سماح في كل مرحلة.

الاستجابة

string
حالة حساب الفوترة: ACTIVE، PAST_DUE، UNPAID، أو SUSPENDED.
string
مستوى إمكانية الميزة الحالي:
  • NORMAL — جميع الميزات متاحة
  • DEGRADED — فشل الدفع؛ لا تزال جميع الميزات تعمل خلال فترة السماح
  • RESTRICTED — فترة السماح على وشك الانتهاء؛ عمليات الكتابة (السك، إنشاء المفاتيح) معطلة
  • SUSPENDED — انتهت فترة السماح؛ تم تعطيل جميع وصول API حتى يتم حل مشكلة الدفع
string | null
طابع زمني ISO 8601 عندما تنتهي فترة السماح الحالية، أو null إذا كان الحساب في وضع جيد.
string | null
رسالة قابلة للقراءة من قبل الإنسان تصف الإجراء المطلوب، أو null عندما لا يكون هناك حاجة لإجراء.

متى تستخدم نقطة النهاية هذه

استخدم GET /v1/billing/status لـ:
  • عرض مطالبات الدفع — تحقق من feature_mode عند بدء تشغيل التطبيق أو تسجيل الدخول واعرض لافتة عندما تكون القيمة أي شيء آخر غير NORMAL.
  • حماية عمليات الكتابة - قبل السك أو إنشاء المفاتيح، تحقق من أن feature_mode ليس RESTRICTED أو SUSPENDED.
  • تتبع مهل السماح — اقرأ grace_until لتظهر لمستخدميك بالضبط المدة المتبقية لديهم لحل مشكلة الدفع.

توقيت فترة السماح

فترات السماح الافتراضية لوضع العقد القياسي هي: تضيف عقود المؤسسات 14 يومًا إضافيًا لكل نافذة. تستخدم العقود الحكومية فترة سماح ثابتة مدتها 90 يومًا بدون تعليق تلقائي. راجع أوضاع العقد للحصول على التفاصيل.
راجع فشل الدفع وفترات السماح للحصول على تفصيل كامل لسير عمل الوصول المتدرج.

التفويضات

X-API-Key
string
header
مطلوب

مفتاح API للمصادقة من جهاز إلى جهاز

الاستجابة

حالة الفوترة

plan
string
status
string
trial_ends_at
string | null