Get the prepaid credit balance and auto-recharge setting

GET /v1/balance

Billable live calls draw the balance down; a call it cannot cover answers 402 insufficient_credits and is not charged. Amounts ending in _micro_usd are millionths of a dollar. Scope: billing.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Responses

Status	Meaning	Body
200	Balance	JSON object
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
429	Rate limit or quota exceeded	`Error`

200: response fields

Field	Type	Description
`object`	`balance`
`balance_micro_usd`	integer	Example: `12340000`.
`balance_usd`	number	Example: `12.34`.
`currency`	`usd`
`low_balance_usd`	number	credits.low fires when the balance falls below this Example: `5`.
`auto_recharge`	object
`auto_recharge.enabled`	boolean
`auto_recharge.threshold_usd`	number	Example: `10`.
`auto_recharge.amount_usd`	number	Example: `20`.
`top_up_url`	string

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/balance" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

The Node.js SDK does not wrap this endpoint yet; call it with fetch.

javascript

const res = await fetch('https://api.joinsimplesms.com/v1/balance', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

python

import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/balance",
    method="GET",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
    },
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)