Get Account Balance

Retrieve current account balance and credit information.

GET /account/balance

Get account balance

cURL

curl --request GET \
  --url https://api.hixbe.com/sms/account/balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Hixbe-Version: <hixbe-version>'

200

{
  "currency": "BDT",
  "balance": 524.25,
  "credit_limit": 1000,
  "low_balance_threshold": 100,
  "auto_recharge": true
}

Authorizations

Authorization · string · header · required

Use your API key as a Bearer token. Format: Authorization: Bearer sk_live_xxxxx

Headers

Hixbe-Version · string · default: 2026-01-01 · required

API version in YYYY-MM-DD format. Using the latest version ensures access to newest features.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

200

application/json

Account balance information

Account balance information

currency · string · required

Currency code (ISO 4217)

Example:

"BDT"

balance · number · required

Current account balance

Required range: x >= 0

Example:

524.25

credit_limit · number | null

Available credit limit (if applicable)

Example:

1000

low_balance_threshold · number

Balance threshold for low balance alerts

Example:

100

auto_recharge · boolean

Whether auto-recharge is enabled

Example:

true