Summarise spend over a window

Spend rolled up over the last days days — totals, the twenty tools that cost the most, and the current balances alongside them so a budget decision needs one request rather than two.

get/api/v1/usage/summary

Request

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

Query parameters

daysinteger

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.

daysinteger required

Length of the window this summary covers, in days.

invocation_countinteger required

Metered calls inside the window.

total_billed_usdnumber required

Total debited from the wallet inside the window.

total_provider_usdnumber required

Total upstream provider cost inside the window.

Changes

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