Get Billing Info

GET /api/billing/info

Get Billing Info

cURL

curl --request GET \
  --url https://api.example.com/api/billing/info \
  --header 'X-Organization-Id: <x-organization-id>'

Response

{
  "plan": {
    "name": "starter",
    "platform_fee": 0.03,
    "concurrent_calls": 5,
    "included_kb_pages_per_month": 100,
    "retention_days": 30,
    "snapshot": {}
  },
  "kb_usage": {
    "pages_used_this_month": 10,
    "pages_included": 100,
    "kb_usage_period": "2024-03",
    "pages_remaining": 90,
    "pages_overage": 0
  },
  "subscription": {
    "status": "active",
    "next_billing_date": "2024-04-01T00:00:00Z",
    "dodo_subscription_id": "sub_xyz789",
    "dodo_customer_id": "cus_abc123"
  },
  "credits": {
    "balance": 500,
    "currency": "USD",
    "low_balance_threshold": 10,
    "last_updated": "2024-03-01T12:00:00Z",
    "last_transaction_id": "txn_def456"
  },
  "transaction_summary": {
    "total_credits_added": 1000,
    "total_credits_used": 500,
    "net_balance": 500,
    "transaction_count": 5
  },
  "recent_transactions": []
}

Retrieve comprehensive billing information for your organization, including current plan details, credit balance, and recent transactions.

Request

X-Organization-Id · string · required

The unique identifier of the organization.

Response

plan · object

Details about the organization’s current billing plan.

Show Plan Details

name · string

The name of the plan (e.g., starter, pro).

platform_fee · number

Platform fee per minute in USD.

concurrent_calls · number

Maximum number of concurrent calls allowed.

included_kb_pages_per_month · number

Number of knowledge base pages included per month.

retention_days · number

Number of days call recordings are retained.

credits · object

Information about available credits.

Show Credit Details

balance · number

Current available balance.

currency · string

Currency code (e.g., USD).

subscription · object

Subscription status and details.

Show Subscription Details

status · string

Current subscription status.

next_billing_date · string

Date of the next billing cycle.

transaction_summary · object

Summary of recent billing transactions.

recent_transactions · array

List of the 10 most recent transactions.

Response

{
  "plan": {
    "name": "starter",
    "platform_fee": 0.03,
    "concurrent_calls": 5,
    "included_kb_pages_per_month": 100,
    "retention_days": 30,
    "snapshot": {}
  },
  "kb_usage": {
    "pages_used_this_month": 10,
    "pages_included": 100,
    "kb_usage_period": "2024-03",
    "pages_remaining": 90,
    "pages_overage": 0
  },
  "subscription": {
    "status": "active",
    "next_billing_date": "2024-04-01T00:00:00Z",
    "dodo_subscription_id": "sub_xyz789",
    "dodo_customer_id": "cus_abc123"
  },
  "credits": {
    "balance": 500,
    "currency": "USD",
    "low_balance_threshold": 10,
    "last_updated": "2024-03-01T12:00:00Z",
    "last_transaction_id": "txn_def456"
  },
  "transaction_summary": {
    "total_credits_added": 1000,
    "total_credits_used": 500,
    "net_balance": 500,
    "transaction_count": 5
  },
  "recent_transactions": []
}