Skip to content

Get project spend

GET
/v1/projects/{id}/spend

Returns what this book has actually cost so far — the sum of its measured page costs, not the up-front /estimate projection. A whitelisted account instead sees "included, no charge."

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)

Parameters

Path Parameters

id*
Type
string
Required
Format
"uuid"

Responses

OK

application/json

A project's actual measured cost-to-date (#1398): the sum of its measured page costs — what was
(or will be) debited — as distinct from the pre-flight BookCostEstimate projection. For an
unlimited/whitelisted owner Unlimited is true and the UI shows "included" rather than
the dollar figure.

Sum of measured page costs for the project so far, USD (0 until a page is measured).

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

Currency code (always USD for now).

Default"USD"

How many pages have a measured cost sample (the basis of the total).

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

True for a whitelisted owner — show "included / no charge".

Playground

Server
Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI