Skip to main content
GET
Retrieve the balance

Authorizations

Authorization
string
header
required

API key issued by Hooper for your organization. Keys are environment-tagged: hk_prod_ keys work against production, hk_stg_ keys against staging.

Response

OK

object
string
Allowed value: "balance"
currency
string
Allowed value: "usd"
available_cents
integer

Credits minus open holds.

held_cents
integer
credit_cents
integer
rate_cents_per_hour
integer
Example:

500

soonest_expiry
integer | null

Unix seconds when the balance next shrinks on its own.