Skip to main content
GET
/
billing
/
balance
Get current balance
curl --request GET \
  --url https://app.sendmux.ai/api/v1/billing/balance \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "balance": "45.230000",
    "balance_purchased": "100.000000",
    "balance_consumed": "54.770000",
    "currency": "USD",
    "auto_topup": {
      "enabled": true,
      "threshold": "10.000000",
      "amount": "50.000000",
      "monthly_limit": "200.000000",
      "monthly_used": "50.000000"
    }
  }
}

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Response

Current balance

ok
enum<boolean>
required
Available options:
true
meta
object
required
data
object
required