Account

Balance, plan and ledger

Two balances, and they behave nothing alike: credits_balance is the monthly grant and resets on credits_renew_at; topup_balance is bought credit and never resets. wallet says which of the two this credential spends, and on an API key it is always topup: the API is billed from bought credit and cannot reach the monthly grant.

get/v1/credits

Request

  • Base URL: https://api.tryplayhead.com
  • URL: https://api.tryplayhead.com/v1/credits
  • Auth: HTTP bearer

Query parameters

limitinteger

How many ledger entries to return.

Response

The balances, the plan's limits, and recent ledger entries.

org_idstring
tierstring
credits_balancenumber

The monthly grant. Resets on credits_renew_at.

credits_renew_atstring date-time nullable
topup_balancenumber

API credit you bought. Never resets. Only a key spends it.

tool_balancenumber

Credit bought for the dashboard and the connector. Never resets. An API key cannot spend it.

wallet'plan' | 'topup'

Which pot this credential spends. topup on every API key. plan only for a person signed in through the connector or the dashboard, and such a call falls through to tool_balance when the grant is gone. A credential is never tool: that is a pot, not a credential.

Changes

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