Retrieve the balance

GET /v1/balance

Retrieve the balance

cURL

curl --request GET \
  --url https://api.hooper.gg/v1/balance \
  --header 'Authorization: Bearer <token>'

200

{
  "object": "balance",
  "currency": "usd",
  "available_cents": 123,
  "held_cents": 123,
  "credit_cents": 123,
  "rate_cents_per_hour": 500,
  "soonest_expiry": 123
}

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

200

application/json

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.