Skip to content

Get total spend

GET
/v1/spend

Returns every book's actual cost-to-date plus a grand total, for a "spend by file" overview across the signed-in user's entire library. The per-project rows reconcile with GET /projects/{id}/spend and the wallet's charge history.

Authorizations

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Responses

OK

application/json

The owner's by-file spend rollup (#1399): every project's actual measured cost-to-date plus a
grand total across the whole library, for the billing "spend by file" overview. This is the spend-
comparison companion to the chronological transaction ledger (TransactionHistoryView,
#1363) — that lists payments/charges in time order; this groups spend by file. The per-row
figures are the same actuals story D (ProjectSpendView) shows, so the overview reconciles
with the per-file totals and with what the wallet was debited.

Currency code (always USD for now).

Default"USD"

How many projects the rollup covers.

Format"int32"
Pattern"^-?(?:0|[1-9]\\d*)$"

One row per owned project (newest-first); the client re-sorts by cost or date.

Grand total of decimal ProjectSpendRow.ActualCostUsd across all projects, USD.

Format"double"
Pattern"^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"

True for a whitelisted owner — the UI shows "included" instead of dollar figures.

Playground

Server
Authorization

Samples

Powered by VitePress OpenAPI