Credits

Get the caller's org credit balance

Return the org's credit balance, status, and plan info.

Reads through :class:~app.services.credit_service.CreditService which caches the balance in Redis and falls back to PostgreSQL.

get/credits/balance

Request

  • Base URL: https://api-docs.jackhamr.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.jackhamr.ai/credits/balance
  • Auth: none declared

Response

Successful Response

organization_idstring required
balancenumber required
currencystring
statusstring required
free_signup_creditnumber
grace_amountnumber
grace_period_daysinteger
lifetime_credits_addednumber
lifetime_credits_usednumber
allowance_usednumber
allowance_remainingnumber
overage_amountnumber
subscription_statusstring nullable
current_period_endstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.