الانتقال إلى المحتوى الرئيسي

Documentation Index

Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt

Use this file to discover all available pages before exploring further.

الفوترة

مراجعة ملخصات الفوترة والفواتير والمعاملات وعمليات الخطط. تستخدم الأمثلة وضع الكود في A2A. يتيح MCP وضع الكود نفسه عبر أداة execute.

الوظائف

billing.current_plan.get

billing.current_plan.get(account_id: str) -> BillingResult
الفوترة: billing.current_plan.get.
الخاصيةالقيمةالخاصيةالقيمة
الإذن المطلوبbilling.viewالمصادقة مطلوبةنعم
وضع التنفيذsyncالصلاحيةbilling.view
نوع الموردaccountحقل معرف الموردaccount_id
مسار API العامGET /v1/public/accounts/{account_id}/billing/current-plan
الاسمالنوعمطلوب
account_idstrنعم
الحقلالنوعمطلوب
billing_periodstrنعم
currencystrنعم
plan_idstrنعم
plan_namestrنعم
pricestrنعم
statusstrنعم
can_cancel_planboolلا
can_change_planboolلا
الطلب:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.current_plan.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
الاستجابة:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.current_plan.get",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
الطلب:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "billing.current_plan.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
الاستجابة:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": true\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"billing.current_plan.get\",\n      \"status\": \"completed\",\n      \"result\": true\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

billing.invoices.list

billing.invoices.list(account_id: str, page?: int, page_size?: int) -> Page[BillingResult]
الفوترة: billing.invoices.list.
الخاصيةالقيمةالخاصيةالقيمة
الإذن المطلوبbilling.viewالمصادقة مطلوبةنعم
وضع التنفيذsyncالصلاحيةbilling.view
نوع الموردaccountحقل معرف الموردaccount_id
مسار API العامGET /v1/public/accounts/{account_id}/billing/invoices
الاسمالنوعمطلوب
account_idstrنعم
pageintلا
page_sizeintلا
الحقلالنوعمطلوب
items[{"amount": str, "currency": str, "date": str, "download_url": str | null, "id": str, "status": str}]نعم
pageintنعم
page_sizeintنعم
totalintنعم
الطلب:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.invoices.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
الاستجابة:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.invoices.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
الطلب:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "billing.invoices.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
  }
}
الاستجابة:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"billing.invoices.list\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

billing.plan.cancel

billing.plan.cancel(account_id: str, cancel_at_period_end?: bool, cancel_immediately?: bool) -> BillingResult
الفوترة: billing.plan.cancel.
الخاصيةالقيمةالخاصيةالقيمة
الإذن المطلوبbilling.manageالمصادقة مطلوبةنعم
وضع التنفيذsyncالصلاحيةbilling.manage
نوع الموردaccountحقل معرف الموردaccount_id
مسار API العامPOST /v1/public/accounts/{account_id}/billing/cancel-plan
الاسمالنوعمطلوب
account_idstrنعم
cancel_at_period_endboolلا
cancel_immediatelyboolلا
الحقلالنوعمطلوب
statusstrنعم
account_statusstr | nullلا
effective_atstr | nullلا
eligiblebool | nullلا
previous_plan_idstr | nullلا
target_plan_idstr | nullلا
الطلب:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.plan.cancel(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", cancel_at_period_end=true, cancel_immediately=true)"
}
الاستجابة:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.plan.cancel",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
الطلب:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "billing.plan.cancel(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", cancel_at_period_end=true, cancel_immediately=true)"
    }
  }
}
الاستجابة:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"billing.plan.cancel\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

billing.plan.change

billing.plan.change(account_id: str, plan_id: "smtp_per_mailbox" | "smtp_per_proxy", effective_date?: str | null) -> BillingResult
الفوترة: billing.plan.change.
الخاصيةالقيمةالخاصيةالقيمة
الإذن المطلوبbilling.manageالمصادقة مطلوبةنعم
وضع التنفيذsyncالصلاحيةbilling.manage
نوع الموردaccountحقل معرف الموردaccount_id
مسار API العامPOST /v1/public/accounts/{account_id}/billing/change-plan
الاسمالنوعمطلوب
account_idstrنعم
plan_id"smtp_per_mailbox" | "smtp_per_proxy"نعم
effective_datestr | nullلا
الحقلالنوعمطلوب
statusstrنعم
account_statusstr | nullلا
effective_atstr | nullلا
eligiblebool | nullلا
previous_plan_idstr | nullلا
target_plan_idstr | nullلا
الطلب:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.plan.change(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", plan_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", effective_date=\"<string>\")"
}
الاستجابة:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.plan.change",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
الطلب:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "billing.plan.change(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", plan_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", effective_date=\"<string>\")"
    }
  }
}
الاستجابة:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": \"<string>\"\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"billing.plan.change\",\n      \"status\": \"completed\",\n      \"result\": \"<string>\"\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

billing.transactions.list

billing.transactions.list(account_id: str, page?: int, page_size?: int) -> Page[BillingResult]
الفوترة: billing.transactions.list.
الخاصيةالقيمةالخاصيةالقيمة
الإذن المطلوبbilling.viewالمصادقة مطلوبةنعم
وضع التنفيذsyncالصلاحيةbilling.view
نوع الموردaccountحقل معرف الموردaccount_id
مسار API العامGET /v1/public/accounts/{account_id}/billing/transactions
الاسمالنوعمطلوب
account_idstrنعم
pageintلا
page_sizeintلا
الحقلالنوعمطلوب
pageintنعم
page_sizeintنعم
totalintنعم
items[{"amount": str, "currency": str, "direction": str, "effective_at": str, "status": str, "transaction_id": str, "type": str, "balance_after"?: str | null, "description"?: str | null}]لا
الطلب:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.transactions.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
الاستجابة:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.transactions.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
الطلب:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "billing.transactions.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
    }
  }
}
الاستجابة:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": 123\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"billing.transactions.list\",\n      \"status\": \"completed\",\n      \"result\": 123\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}

billing.wallet_balance.get

billing.wallet_balance.get(account_id: str) -> BillingResult
الفوترة: billing.wallet_balance.get.
الخاصيةالقيمةالخاصيةالقيمة
الإذن المطلوبbilling.viewالمصادقة مطلوبةنعم
وضع التنفيذsyncالصلاحيةbilling.view
نوع الموردaccountحقل معرف الموردaccount_id
مسار API العامGET /v1/public/accounts/{account_id}/billing/wallet-balance
الاسمالنوعمطلوب
account_idstrنعم
الحقلالنوعمطلوب
accrued_chargesstrنعم
balancestrنعم
currencystrنعم
net_balancestrنعم
الطلب:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.wallet_balance.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
الاستجابة:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": {
      "accrued_charges": "<string>",
      "balance": "<string>",
      "currency": "<string>",
      "net_balance": "<string>"
    }
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.wallet_balance.get",
      "status": "completed",
      "result": {
        "accrued_charges": "<string>",
        "balance": "<string>",
        "currency": "<string>",
        "net_balance": "<string>"
      }
    }
  ],
  "complexity_score": 1
}
الطلب:
{
  "jsonrpc": "2.0",
  "id": "example",
  "method": "tools/call",
  "params": {
    "name": "hybridbox_execute",
    "arguments": {
      "code": "billing.wallet_balance.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
    }
  }
}
الاستجابة:
{
  "jsonrpc": "2.0",
  "id": "example",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\n  \"request_id\": \"example\",\n  \"status\": \"completed\",\n  \"result\": {\n    \"last_value\": {\n      \"accrued_charges\": \"<string>\",\n      \"balance\": \"<string>\",\n      \"currency\": \"<string>\",\n      \"net_balance\": \"<string>\"\n    }\n  },\n  \"responses\": [\n    {\n      \"index\": 0,\n      \"function\": \"billing.wallet_balance.get\",\n      \"status\": \"completed\",\n      \"result\": {\n        \"accrued_charges\": \"<string>\",\n        \"balance\": \"<string>\",\n        \"currency\": \"<string>\",\n        \"net_balance\": \"<string>\"\n      }\n    }\n  ],\n  \"complexity_score\": 1\n}"
      }
    ],
    "isError": false
  }
}