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

لخطة شهرية مدفوعة، يطلب دفعًا مستضافًا من مزود متاح باستخدام بلد الفواتير المسجل. يمكن لخطط الأعمال القائمة على الاستخدام بدلاً من ذلك إرجاع `activated: true` بدون دفع مستضاف؛ لا يزال من الممكن أن تتكبد رسوم استخدام.

يجب على الموظفين الموافقة على بلد الفوترة قبل تفعيل الخطط المدفوعة أو المستويات التجارية القائمة على الاستخدام. يعيد البلد غير الموافق عليه HTTP `409` مع `code: BILLING_COUNTRY_REVIEW_REQUIRED`. أكمل مراجعة البلد في صفحة الفوترة بعد تسجيل الدخول أولاً.

أرسل مزودًا من `visible_providers` الخاص بالحساب. لا يمكن لمعامل URL تغيير بلد الفوترة. يجب إدارة الاشتراكات الشخصية المدفوعة الحالية قبل بدء عملية دفع أخرى. ترفض Flutterwave الدفع الشهري إذا كان خطة الدفع المتكررة مفقودة.

رابط الدفع ليس إثباتًا للدفع. قم بتحديث الاشتراك بعد تأكيد المزود.

## الاستجابة

**checkout\_url** `string`

عنوان URL لصفحة الدفع المستضافة. أعد توجيه المستخدم إلى عنوان URL هذا لإكمال الدفع.


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/billing/checkout
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/checkout:
    post:
      tags:
        - Billing
      summary: إنشاء جلسة دفع
      description: ينشئ جلسة دفع مستضافة لترقية الخطة أو إنشاء اشتراك.
      operationId: billing.checkout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                cancel_url:
                  type: string
                  description: عنوان URL لإعادة التوجيه عند إلغاء عملية الدفع
                email:
                  type: string
                plan_key:
                  type: string
                provider:
                  type: string
                  enum:
                    - stripe
                    - flutterwave
                success_url:
                  type: string
                  description: عنوان URL لإعادة التوجيه بعد إتمام عملية الدفع بنجاح
              type: object
              required:
                - plan_key
      responses:
        '200':
          description: جلسة الدفع
          content:
            application/json:
              schema:
                type: object
                properties:
                  checkout_url:
                    type: string
                  activated:
                    type: boolean
                  plan_key:
                    type: string
                  message:
                    type: string
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: مراجعة البلد مطلوبة، أو يجب إدارة اشتراك شخصي حالي أولاً.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: BILLING_COUNTRY_REVIEW_REQUIRED
                  error:
                    type: string
      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.