> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# الحصول على حالة الفواتير

> يعرض حالة الفوترة الحالية، ووضع الميزة، وفترة السماح للمستأجر الموثق.

```http theme={null}
GET /v1/billing/status
```

يعرض الحالة الصحية الحالية لفوترة المستأجر الخاص بك. استخدم نقطة النهاية هذه في تكاملك لاكتشاف مشكلات الدفع مبكرًا وعرض المطالبات لمستخدميك قبل تقييد الوصول.

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

## الاستجابة

**status** `string`

حالة حساب الفوترة: `ACTIVE`، `PAST_DUE`، `UNPAID`، أو `SUSPENDED`.

**feature\_mode** `string`

مستوى إمكانية الميزة الحالي:

* `NORMAL` — جميع الميزات متاحة
* `DEGRADED` — فشل الدفع؛ لا تزال جميع الميزات تعمل خلال فترة السماح
* `RESTRICTED` — فترة السماح على وشك الانتهاء؛ عمليات الكتابة (السك، إنشاء المفاتيح) معطلة
* `SUSPENDED` — انتهت فترة السماح؛ تم تعطيل جميع وصول API حتى يتم حل مشكلة الدفع

**grace\_until** `string | null`

طابع زمني ISO 8601 عندما تنتهي فترة السماح الحالية، أو `null` إذا كان الحساب في وضع جيد.

**banner** `string | null`

رسالة قابلة للقراءة من قبل الإنسان تصف الإجراء المطلوب، أو `null` عندما لا يكون هناك حاجة لإجراء.

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

استخدم `GET /v1/billing/status` لـ:

* **عرض مطالبات الدفع** — تحقق من `feature_mode` عند بدء تشغيل التطبيق أو تسجيل الدخول واعرض لافتة عندما تكون القيمة أي شيء آخر غير `NORMAL`.
* **حماية عمليات الكتابة** - قبل السك أو إنشاء المفاتيح، تحقق من أن `feature_mode` ليس `RESTRICTED` أو `SUSPENDED`.
* **تتبع مهل السماح** — اقرأ `grace_until` لتظهر لمستخدميك بالضبط المدة المتبقية لديهم لحل مشكلة الدفع.

```javascript theme={null}
const res = await fetch("https://api.truthlocks.com/v1/billing/status", {
  headers: { "X-API-Key": "tl_live_..." },
});
const { feature_mode, grace_until } = await res.json();

if (feature_mode !== "NORMAL") {
  showPaymentBanner(feature_mode, grace_until);
}
```

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

فترات السماح الافتراضية لوضع العقد القياسي هي:

| الانتقال | نافذة السماح | الإشعارات |
| :- | :- | :- |
| عادي ← متدهور | 7 أيام | تذكيرات عند T+24 ساعة، T+48 ساعة، T+72 ساعة |
| متدهور ← مقيد | 14 يومًا | تذكيرات عند T+24 ساعة، T+48 ساعة، T+72 ساعة |
| مقيد ← معلق | فوري | إشعار تعليق نهائي |

تضيف عقود المؤسسات 14 يومًا إضافيًا لكل نافذة. تستخدم العقود الحكومية فترة سماح ثابتة مدتها 90 يومًا بدون تعليق تلقائي. راجع [أوضاع العقد](https://docs.truthlocks.com/ar/billing/overview.md#contract-modes) للحصول على التفاصيل.

> [!TIP]
>
> راجع [فشل الدفع وفترات السماح](https://docs.truthlocks.com/ar/billing/overview.md#payment-failures-and-grace-periods) للحصول على تفصيل كامل لسير عمل الوصول المتدرج.


## OpenAPI

````yaml ar/mint-openapi.yaml GET /v1/billing/status
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks هي بنية تحتية عالمية للتحقق من المستندات وبيانات الاعتماد والأصول
    الرقمية.يحدد هذا المواصفات واجهة برمجة التطبيقات (API) الأساسية للتفاعل مع
    خدمات Truthlocks.


    ## عناوين URL الأساسية

    - **الإنتاج**: `https://api.truthlocks.com`

    - **البيئة التجريبية (Sandbox)**: `https://sandbox-api.truthlocks.com`


    ## المصادقة

    - **مفاتيح API**: استخدم رأس `X-API-Key` للعمليات من جهاز إلى جهاز

    - **رموز Bearer**: استخدم `Authorization: Bearer <jwt>` للعمليات التي يبدأها
    المستخدم


    ## هوية المستأجر

    في بيئة الإنتاج، تُستمد هوية المستأجر من السياق المصادق عليه (مفتاح API أو
    JWT).

    يتم تجاهل رأس `X-Tenant-ID` في بيئة الإنتاج لمنع الانتحال.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: واجهة برمجة تطبيقات الإنتاج
  - url: https://sandbox-api.truthlocks.com
    description: بيئة اختبار (Sandbox)
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: إدارة مفاتيح ورموز API
  - name: Issuers
    description: تسجيل المصدر وإدارة الثقة
  - name: Keys
    description: إدارة المفاتيح التشفيرية لجهات الإصدار
  - name: Attestations
    description: دورة حياة الإشهاد (السك، الإلغاء، الاستبدال)
  - name: Verification
    description: حزم التحقق والإثبات للإشهاد
  - name: Governance
    description: سير عمل حوكمة المصدر (للمسؤول فقط)
  - name: Identity
    description: إدارة المنظمة والمستخدمين والأدوار
  - name: Audit
    description: استعلامات أحداث التدقيق
  - name: Tenant Console
    description: ملف تعريف المستأجر ونقاط نهاية دورة الحياة
  - name: Health
    description: نقاط نهاية صحة الخدمة وجاهزيتها
  - name: Risk
    description: استيعاب إشارة المخاطر واكتشاف الاحتيال
  - name: Risk Enforcement
    description: إجراءات إنفاذ المخاطر — الحظر والتحدي والحجر والتكوين
  - name: Billing
    description: إدارة الفوترة والاشتراكات والإضافات
  - name: Machine Identity
    description: >-
      بروتوكول هوية وكيل الآلة (MAIP) — تسجيل الوكيل، الجلسات، الثقة، الشهادة،
      الامتثال، التنسيق، والمراقبة
externalDocs:
  description: واجهة برمجة تطبيقات الشفافية للقراءة فقط (مواصفات خدمة منفصلة)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/billing/status:
    get:
      tags:
        - Billing
      summary: الحصول على حالة الفواتير
      description: يعرض حالة الفوترة والخطة الحالية وعلامات الميزات للمستأجر الموثق.
      operationId: billing.status
      responses:
        '200':
          description: حالة الفوترة
          content:
            application/json:
              schema:
                type: object
                properties:
                  plan:
                    type: string
                  status:
                    type: string
                  trial_ends_at:
                    nullable: true
                    type: string
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: رمز خطأ قابل للقراءة آليًا
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: رسالة خطأ مقروءة بشريًا
        http_status:
          type: integer
          description: رمز حالة HTTP
        retry_after_ms:
          type: integer
          description: عدد المللي ثانية للانتظار قبل إعادة المحاولة (لحدود المعدل)
        details:
          type: object
          description: سياق خطأ إضافي
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: مفتاح API للمصادقة من جهاز إلى جهاز
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT للعمليات التي يبدأها المستخدم

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.