vision

get/api/projects/{project_id}/vision/quota/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/vision/quota/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

credit_limitinteger nullable required

Credits the organization may spend per billing period (1 credit = $0.01). 0 is a hard block: no observation can start. Null when billing has synced the product with no spend limit: uncapped.

credits_usedinteger required

credits_settled plus credits_reserved: the organization's total draw on credit_limit this period, across every project.

credits_settledinteger required

Credits posted to the receipt ledger by succeeded observations and finished prompt-test sessions this period, across every project in the organization. Deleting an observation never refunds these.

credits_reservedinteger required

Credits held by in-flight observations across every project in the organization. Released without charge when the work fails, settled into credits_settled when it succeeds.

remaininginteger nullable required

credit_limit - credits_used, floored at 0. Null when uncapped.

exhaustedboolean required

True when credits_used >= credit_limit; further observations are skipped until next period. Always false when uncapped.

period_startstring date-time required

First moment of the current quota period (UTC).

period_endstring date-time required

First moment of the next quota period (UTC); the current period's exclusive upper bound.

projected_monthly_creditsinteger required

scanners_monthly_credits plus backfills_committed_credits. Kept as the single headline number; prefer the two components when pro-rating, since only the scanner half is a monthly rate.

scanners_monthly_creditsinteger required

Credit-weighted sum of enabled scanners' projected observations/month across the organization. A capped scanner contributes at most what its own credit limit has left this period, folded back into a 30-day rate. A monthly rate: only the part falling in the days left of the period lands this period. Scanners without a computed estimate contribute 0.

backfills_committed_creditsinteger required

Committed-but-unspent credits of the organization's active backfills. A one-off charge rather than a rate, so it lands in full regardless of how much of the period is left.

free_monthly_creditsinteger required

Credits per period included for free. Already counted inside credit_limit; only credits beyond this number are billed.

Changes

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