Skip to navigation
Synthesia API referencebilling

Get the credit balance

Get your workspace’s current billing period and its credit balance.

Amounts are decimal strings (e.g. "288.00").

Authentication

AuthorizationBearer

Your Synthesia API key.

  • Send it as Authorization: Bearer <key>; a bare key also works.
  • An endpoint that needs a scope names it in its description; Scopes lists them all.
  • A :write scope also satisfies the same resource’s :read.
  • Without the scope, the request fails with a 403 insufficient_scope.

Response headers

Request-IdstringOptional
The id of this request's audit record. Quote it when reporting a problem.

Response

Successful Response
periodobject
The billing window's start and end timestamps.
creditsobject

A workspace’s wallet balance and latest-period usage.

Amounts are decimal strings, not floats, to avoid precision loss on money.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error