> ## 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/usage
```

يعرض عدادات الاستخدام المقاسة لفترة الفوترة الحالية. يتتبع كل عداد موردًا قابلاً للفوترة ويوضح مقدار ما استهلكته بالنسبة إلى حد خطتك.

## الاستجابة

يعرض مصفوفة من كائنات عداد الاستخدام.

**metric** `string`

معرف مقياس الاستخدام (على سبيل المثال، `attestations.mint`، `verifications_monthly`، `storage_bytes`).

**used** `integer`

المبلغ المستهلك في فترة الفوترة الحالية.

**limit** `integer`

الحد الأقصى المسموح به لهذا المقياس بموجب خطتك. تشير القيمة `-1` إلى عدم وجود حصة مكوّنة لهذا المقياس؛ لا تزال حدود الخدمة والمعدل سارية.

**period** `string`

فترة الفوترة لهذا العداد: `monthly` أو `total`.

**unit** `string`

وحدة القياس: `count` أو `bytes`.

**allowed** `boolean`

ما إذا كان المستأجر مسموحًا له حاليًا باستهلاك المزيد من هذا المقياس. يُرجع `false` عند الوصول إلى الحد الأقصى. يتم تضمينه فقط عند الاقتضاء.

**delta** `integer`

التغيير في الاستخدام منذ الاستعلام الأخير. يتم تضمينه فقط عندما يتتبع الخادم التحديثات التزايدية.

### المقاييس المتتبعة

تُرجع نقطة نهاية الاستخدام ما يصل إلى 16 مقياسًا منظمة حسب مجموعة المنتج. تعتمد المقاييس التي تظهر على خطتك والميزات النشطة.

#### أساسي

| المقياس | الوصف | الوحدة |
| - | - | - |
| `attestations.mint` | الشهادات التي تم إنشاؤها | `count` |
| `verifications_monthly` | التحققات التي تم إجراؤها | `count` |
| `storage_bytes` | إجمالي التخزين المستهلك | `bytes` |
| `proof_bundles` | حزم الإثبات التي تم إنشاؤها | `count` |
| `webhook_endpoints` | نقاط نهاية webhook النشطة | `count` |
| `webhook_deliveries` | عمليات تسليم Webhook المرسلة | `count` |
| `seats` | مقاعد أعضاء الفريق | `count` |

#### MAIP (هوية الجهاز)

| المقياس | الوصف | الوحدة |
| - | - | - |
| `maip.agents` | وكلاء الجهاز المسجلون | `count` |
| `maip.sessions` | جلسات الوكيل التي تم إنشاؤها | `count` |
| `maip.trust_computes` | حسابات درجة الثقة | `count` |
| `maip.compliance_checks` | طلبات التحقق من الامتثال | `count` |

#### الذكاء الاصطناعي

| المقياس | الوصف | الوحدة |
| - | - | - |
| `ai.dataset_attestations` | مجموعات البيانات المصدقة للنسب | `count` |
| `ai.model_attestations` | النماذج المصدقة للأصل | `count` |

#### مكافحة الاحتيال

| المقياس | الوصف | الوحدة |
| - | - | - |
| `antifraud.risk_signals` | إشارات المخاطر المستوعبة أو المولدة | `count` |
| `antifraud.deepfake_scans` | طلبات فحص التزييف العميق | `count` |
| `antifraud.velocity_records` | سجلات تسجيل السرعة | `count` |

> [!TIP]
>
> للتحقق مما إذا كانت عملية معينة مسموح بها قبل إجرائها، استخدم [نقطة نهاية الاستحقاقات](https://docs.truthlocks.com/ar/api-reference/billing/entitlements.md) للتحقق من حصصك.

## لوحة تحكم Console

يمكنك أيضًا عرض الاستخدام بصريًا في وحدة التحكم في **الإعدادات > الفواتير > الاستخدام**. تعرض لوحة المعلومات جميع المقاييس الـ 16 منظمة حسب مجموعة المنتج (الأساسي، MAIP، الذكاء الاصطناعي، ومكافحة الاحتيال)، وكل منها معروض كشريط تقدم مقابل حد خطتك. يتم حساب التكلفة الشهرية المتوقعة بناءً على استهلاكك الحالي ومعدلات الوحدة الفعالة.


## OpenAPI

````yaml ar/mint-openapi.yaml GET /v1/billing/usage
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/usage:
    get:
      tags:
        - Billing
      summary: الحصول على استخدام الفواتير
      description: يعرض الاستخدام المقاس لفترة الفوترة الحالية.
      operationId: billing.usage
      parameters:
        - name: period
          in: query
          schema:
            type: string
          description: فترة الفوترة (مثل "2026-04")
      responses:
        '200':
          description: بيانات الاستخدام
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: string
                  usage:
                    type: object
                    additionalProperties: true
        '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.