Skip to navigation

Read balances

Reads your remaining prepaid credit.

Call it before sending a batch of work, to decide when to buy a pack, or to show usage to your own users. Speech-to-text and text-to-speech balances are independent and reported separately, with the seconds and characters they still cover. billing_hold is true when a payment problem is blocking requests on the account. Negative balances after refunds remain visible.

Authentication

AuthorizationBearer

Your Llynx API key, sent as Authorization: Bearer <key>.

Response

Current balances for both services
sttobject
ttsobject
billing_holdboolean
True when a payment problem is blocking requests on the account.
as_ofdatetime
Time of this snapshot.

Errors

401
Unauthorized Error
403
Forbidden Error
503
Service Unavailable Error