Workspace

Get plan and usage

The plan in force (including a trial), every limit, and this month's usage: runs against the allowance, sources, API keys, seats and stored evidence. Use it before creating sources or queueing runs to avoid a 402 plan_limit.

get/v1/usage

Request

  • Base URL: https://sourcefinch.com
  • URL: https://sourcefinch.com/v1/usage
  • Auth: HTTP bearer

Headers

X-Request-Idstring

Echoed in the response and logs; generated when absent.

SourceFinch-Projectstring uuid

Project UUID. Required for session tokens; API keys are bound to their project.

Response

Plan and usage

planstring required

The plan in force now (during a trial, the trial plan)

retention_grace_untilstring nullable required

After a downgrade, over-limit items stay paused (not deleted) until then

limitsobject required

Every limit of the plan in force (schedule floor, retention days, browser mode, origins per day, …)

upgrade_urlstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.