Skip to main content
GET
/
api
/
billing
/
info
Get Billing Info
curl --request GET \
  --url https://api.example.com/api/billing/info \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "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.
credits
object
Information about available credits.
subscription
object
Subscription status and details.
transaction_summary
object
Summary of recent billing transactions.
recent_transactions
array
List of the 10 most recent transactions.
{
  "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": []
}