> ## 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}
POST /v1/billing/projected-invoice
```

يُرجع توقع فاتورة مفصلة بناءً على أحجام الاستخدام التي تقدمها. المصادقة مطلوبة. استخدم مفتاح API لمساحة العمل الخاصة بك. استخدمه لحسابات التسعير، أو توقع التكلفة، أو أدوات ما قبل البيع.

يتم تطبيق تعديلات الأسعار الإقليمية عند تضمين `country_code`. تستخدم نقطة النهاية هذه بطاقة الأسعار القياسية، وليس اتفاقية مستأجر متفاوض عليها. قدم الكميات **القابلة للفوترة** المتوقعة؛ لا تحسب هذه الآلة الحاسبة البدلات المجانية أو تصنف نشاط وضع الحماية.

تسعير الحجم متدرج. يسعر كل نطاق العمليات في هذا النطاق فقط. تحدد الاستجابة `billing_model: "pay_per_use"`، `volume_pricing: "graduated"`، `amount_unit: "cents"`، و `estimate_only: true`. لا ينشئ التقدير فاتورة أو يفرض رسومًا عليها. تُرجع تعريفات الأسعار المفقودة أو المتداخلة أو غير المكتملة `422 invalid_pricing`؛ وتُرجع الكميات غير الآمنة والخطط غير المعروفة `400 bad_request`.

الأسعار المطبقة بالضبط موجودة في `line_items`. يتم الاحتفاظ بالحقول العددية الملائمة `rates_used` للتوافق مع بطاقات الأسعار الثابتة؛ وهي ليست سعرًا مختلطًا ويجب عدم ضربها عبر نطاقات الحجم.

## الاستجابة

**line\_items** `object[]`

تفصيل الرسوم المتوقعة.

**description** `string`

الحد الأقصى لسك التصديقات لكل دورة فوترة.

**quantity** `integer`

معدل السك لكل عملية بالسنوات.

**unit\_price\_cents** `integer`

معدل التحقق لكل عملية بالسنوات.

**total\_cents** `integer`

العدد الإجمالي للإيصالات الصالحة التي جمعها الوكيل.

**subtotal** `integer`

المجموع الفرعي لرسوم الاستخدام بالسنت (قبل رسوم المنصة).

**total** `integer`

التكلفة الإجمالية المتوقعة بالسنت (الاستخدام + رسوم المنصة).

**currency** `string`

رمز عملة بطاقة الأسعار (حاليًا `USD`).

**rates\_used** `object`

الأسعار المطبقة على هذا الإسقاط.

**mint\_rate\_cents** `integer`

سعر الوحدة بالسنوات.

**verify\_rate\_cents** `integer`

مستوى منطقة التسعير المطبق.

**platform\_fee** `integer`

عدد الوحدات.

**region** `string`

نسبة الأحداث الشاذة إلى إجمالي الأحداث في نافذة التسجيل.

**multiplier** `number`

مضاعف السعر الإقليمي.

> [!NOTE]
>
> جميع المبالغ بالسنتا. اقسم على 100 للتحويل إلى دولارات. تنطبق المضاعفات الإقليمية تلقائيًا عند تضمين `country_code`.


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/billing/projected-invoice
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/projected-invoice:
    post:
      tags:
        - Billing
      summary: فاتورة المشروع التالية
      description: >-
        تقدير كميات السك والتحقق القابلة للفوترة باستخدام قائمة الأسعار القياسية
        ونطاقات الحجم المتدرجة. لا يتم فرض رسوم أو تسوية أسعار متفاوض عليها خاصة
        أو خصم مخصصات مجانية. المبالغ هي سنتات صحيحة.
      operationId: billing.projectedInvoice
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                country_code:
                  type: string
                mints:
                  type: integer
                  minimum: 0
                  maximum: 1000000000
                plan_key:
                  type: string
                verifications:
                  type: integer
                  minimum: 0
                  maximum: 1000000000
              type: object
      responses:
        '200':
          description: الفاتورة المتوقعة
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  subtotal:
                    type: integer
                  amount_unit:
                    type: string
                    enum:
                      - cents
                  billing_model:
                    type: string
                    enum:
                      - pay_per_use
                  volume_pricing:
                    type: string
                    enum:
                      - graduated
                  estimate_only:
                    type: boolean
                  currency:
                    type: string
                  line_items:
                    type: array
                    items:
                      type: object
        '400':
          description: كمية غير صالحة أو خطة غير معروفة
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: المعدلات المكونة لا يمكنها تسعير هذا الاستخدام
      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.