Organization Billing

Get Credit Balance

Changed on

Get current credit balance and tier information.

Returns the organization's credit balance, current tier, and usage statistics. Useful for displaying billing status in dashboards.

Requirements:

  • Read permission

Example:

response = await client.get("/v1/organizations/billing/balance")
print(f"Balance: {response['credit_balance']} credits")
print(f"Tier: {response['account_tier']}")
get/v1/organizations/billing/balance

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/organizations/billing/balance
  • Auth: HTTP bearer

Response

Successful Response

organization_idstring required

Organization identifier

credit_balanceinteger required

Current credit balance. For FREE tier without auto-billing, this is remaining free tier credits. For auto-billing accounts, this shows current month usage (negative indicates consumption).

account_tierstring required

Current account tier: free, pro, team, enterprise

next_tierstring nullable

Next available tier or null if at max tier

credits_until_next_tierinteger nullable

Credits needed to reach next tier (null if at max tier or N/A)

estimated_days_remaininginteger nullable

Estimated days until credits depleted based on 7-day burn rate. Null if no usage history or unlimited (auto-billing enabled).

daily_burn_ratenumber

Average credits consumed per day (7-day rolling average)

Example response

{
  "organization_id": "org_demo123",
  "credit_balance": 45230,
  "account_tier": "free",
  "next_tier": "pro",
  "credits_until_next_tier": 954770,
  "estimated_days_remaining": 15,
  "daily_burn_rate": 3015.3
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API