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

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

## الاستجابة

**recommended\_plan\_key** `string`

الخطة التي تناسب متطلباتك (على سبيل المثال، `plan_starter`، `plan_business`).

**recommended\_addons** `object[]`

الإضافات التي يقترحها التقدير بناءً على احتياجاتك (مثل المقاعد الإضافية التي تتجاوز حد الخطة).

**estimated\_monthly\_total** `number`

التكلفة الشهرية المتوقعة بالدولار الأمريكي.

**currency** `string`

رمز العملة (`USD`).

**assumptions** `string[]`

ملاحظات حول التقدير (مثل خصومات الحجم، التسعير المخصص).

**provider\_routing** `object`

معلومات مزود الدفع للبلد المحدد.

**default\_provider** `string`

وصف تفصيلي للنتيجة وإرشادات العلاج.

**visible\_providers** `string[]`

السعر الأساسي بأصغر وحدة عملة (سنتات للدولار الأمريكي).

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


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/billing/estimate
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/estimate:
    post:
      tags:
        - Billing
      summary: تقدير الفواتير
      description: يُرجع تقديرًا للتكلفة لتغيير خطة أو إضافة دون تنفيذها.
      operationId: billing.estimate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                contract_mode:
                  type: string
                country_code:
                  type: string
                expected_verifications_monthly:
                  type: integer
                issuers_needed:
                  type: integer
                storage_gb:
                  type: integer
                team_seats:
                  type: integer
                webhook_endpoints_needed:
                  type: integer
              type: object
      responses:
        '200':
          description: تقدير التكلفة
          content:
            application/json:
              schema:
                type: object
                properties:
                  subtotal:
                    type: number
                  tax:
                    type: number
                  total:
                    type: number
                  currency:
                    type: string
                  proration:
                    type: number
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security: []
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.