Get the prepaid credit balance and auto-recharge setting

Billable live calls draw the balance down; a call it cannot cover answers 402 insufficient_credits and is not charged.

GET/v1/balance

Details

Amounts ending in _micro_usd are millionths of a dollar. Scope: billing.

Responses

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

Response Fields

objectbalance
balance_micro_usdinteger
Example: 12340000.
balance_usdnumber
Example: 12.34.
currencyusd
low_balance_usdnumber
credits.low fires when the balance falls below this Example: 5.
auto_rechargeobject
auto_recharge.enabledboolean
auto_recharge.threshold_usdnumber
Example: 10.
auto_recharge.amount_usdnumber
Example: 20.
top_up_urlstring

Errors

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.

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

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

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

Response 200

{
  "object": "balance",
  "balance_micro_usd": 12340000,
  "balance_usd": 12.34,
  "low_balance_usd": 5
}