Balance

GET
/api/v1/usage/balance

Authorization

bearerAuth
headerAuthorizationBearer <token>

An API key created in Capy under Settings → API.

Response body

UsageBalance

application/json
  1. response
currency*"USD"

The currency of every dollar amount in the response.

One of"USD"
remainingDollars*||

Spendable plan and purchased credit, valued in dollars; not a cash or refundable balance. Negative once overdrawn. Null when the organization has no credit balance or an unlimited grant.

unlimited*boolean
periodStart*|

Start of the current subscription period. Null without a plan; usage windows then default to the UTC calendar month.

periodEnd*|

End of the current subscription period; null without a plan.

curl -X GET 'https://api.capy.ai/api/v1/usage/balance'
{  "currency": "USD",  "remainingDollars": 0,  "unlimited": true,  "periodStart": "string",  "periodEnd": "string"}
Open in Capy