Skip to main content
GET
Usage pool balance and metered activity

Authorizations

Authorization
string
header
required

Partner API key issued by Cactus.

Query Parameters

period_start
string<date>

Defaults to the first day of the current month.

period_end
string<date>

Defaults to today.

Response

200 - application/json

Balance and per-rate-code usage for the period.

pool
object
required
period
object
required
overage_usd
string

Period spend beyond the prepaid pool (invoiced in arrears).

Example:

"0.00"