Naar hoofdinhoud gaan

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.

Facturering

Factureringsoverzichten, facturen, transacties en planbewerkingen bekijken. De voorbeelden gebruiken de A2A-codemodus. MCP biedt dezelfde codemodus via het hulpmiddel execute.

Functies

billing.current_plan.get

billing.current_plan.get(account_id: str) -> BillingResult
Facturering: billing.current_plan.get.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingbilling.viewAuthenticatie vereistja
UitvoermodussyncMogelijkheidbilling.view
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeGET /v1/public/accounts/{account_id}/billing/current-plan
NaamTypeVereist
account_idstrja
VeldTypeVereist
billing_periodstrja
currencystrja
plan_idstrja
plan_namestrja
pricestrja
statusstrja
can_cancel_planboolnee
can_change_planboolnee
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.current_plan.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": true
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.current_plan.get",
      "status": "completed",
      "result": true
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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\")"
    }
  }
}
Respons:
{
  "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]
Facturering: billing.invoices.list.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingbilling.viewAuthenticatie vereistja
UitvoermodussyncMogelijkheidbilling.view
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeGET /v1/public/accounts/{account_id}/billing/invoices
NaamTypeVereist
account_idstrja
pageintnee
page_sizeintnee
VeldTypeVereist
items[{"amount": str, "currency": str, "date": str, "download_url": str | null, "id": str, "status": str}]ja
pageintja
page_sizeintja
totalintja
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.invoices.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.invoices.list",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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)"
    }
  }
}
Respons:
{
  "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
Facturering: billing.plan.cancel.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingbilling.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidbilling.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/billing/cancel-plan
NaamTypeVereist
account_idstrja
cancel_at_period_endboolnee
cancel_immediatelyboolnee
VeldTypeVereist
statusstrja
account_statusstr | nullnee
effective_atstr | nullnee
eligiblebool | nullnee
previous_plan_idstr | nullnee
target_plan_idstr | nullnee
Aanvraag:
{
  "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)"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.plan.cancel",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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)"
    }
  }
}
Respons:
{
  "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
Facturering: billing.plan.change.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingbilling.manageAuthenticatie vereistja
UitvoermodussyncMogelijkheidbilling.manage
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routePOST /v1/public/accounts/{account_id}/billing/change-plan
NaamTypeVereist
account_idstrja
plan_id"smtp_per_mailbox" | "smtp_per_proxy"ja
effective_datestr | nullnee
VeldTypeVereist
statusstrja
account_statusstr | nullnee
effective_atstr | nullnee
eligiblebool | nullnee
previous_plan_idstr | nullnee
target_plan_idstr | nullnee
Aanvraag:
{
  "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>\")"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": "<string>"
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.plan.change",
      "status": "completed",
      "result": "<string>"
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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>\")"
    }
  }
}
Respons:
{
  "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]
Facturering: billing.transactions.list.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingbilling.viewAuthenticatie vereistja
UitvoermodussyncMogelijkheidbilling.view
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeGET /v1/public/accounts/{account_id}/billing/transactions
NaamTypeVereist
account_idstrja
pageintnee
page_sizeintnee
VeldTypeVereist
pageintja
page_sizeintja
totalintja
items[{"amount": str, "currency": str, "direction": str, "effective_at": str, "status": str, "transaction_id": str, "type": str, "balance_after"?: str | null, "description"?: str | null}]nee
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.transactions.list(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\", page=123, page_size=123)"
}
Respons:
{
  "request_id": "example",
  "status": "completed",
  "result": {
    "last_value": 123
  },
  "responses": [
    {
      "index": 0,
      "function": "billing.transactions.list",
      "status": "completed",
      "result": 123
    }
  ],
  "complexity_score": 1
}
Aanvraag:
{
  "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)"
    }
  }
}
Respons:
{
  "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
Facturering: billing.wallet_balance.get.
EigenschapWaardeEigenschapWaarde
Vereiste machtigingbilling.viewAuthenticatie vereistja
UitvoermodussyncMogelijkheidbilling.view
ResourcetypeaccountResource-ID-veldaccount_id
Openbare API-routeGET /v1/public/accounts/{account_id}/billing/wallet-balance
NaamTypeVereist
account_idstrja
VeldTypeVereist
accrued_chargesstrja
balancestrja
currencystrja
net_balancestrja
Aanvraag:
{
  "request_id": "example",
  "session_id": "session_123",
  "code": "billing.wallet_balance.get(account_id=\"3c90c3cc-0d44-4b50-8888-8dd25736052a\")"
}
Respons:
{
  "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
}
Aanvraag:
{
  "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\")"
    }
  }
}
Respons:
{
  "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
  }
}