Read wallet balances

Returns the two pools a call is paid from: plan credit, which burns at the end of the billing period and is spent first, and top-up credit, which never expires. Figures are rounded to whole cents at this boundary.

get/api/v1/wallet

Request

  • Base URL: https://prowl.chat
  • URL: https://prowl.chat/api/v1/wallet
  • Auth: HTTP bearer

Headers

authorizationstring nullable

Cookies

prowl_sessionstring nullable

Response

Successful Response

subscription_balance_usdnumber required

Plan credit for the current period. Burns at period end, spent first.

extra_balance_usdnumber required

Top-up credit. Never expires, spent after the subscription pool.

total_available_usdnumber required

What the next call can draw on: the two pools added together.

updated_atstring nullable

ISO-8601 timestamp of the last balance change, or null if never moved.

Changes

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