Skip to main content

Get the current month budget and usage

GET 

https://platform.docana.com/api/v1/usage/

The company's budget position for the current calendar month (UTC): the plan's monthly budget, what the metered usage has cost so far, what is left, and the metered quantities behind that number. Read it before starting a large job: once budget.exceeded is true every metered operation (document ingestion, search, messages) answers 402 with code: "budget-exceeded" until the month rolls over or the budget is raised. Creating collections and folders is not metered and keeps working. Ingestion is metered per processed page and per media minute, not per file, so cost tracks pages and images rather than file count.

Responses

The current month budget and usage