Account

Current-period usage and quota

Returns the calling key's current-period API usage, included allotment, remaining calls, configured per-minute and per-day rate limits, and the hard-cap status. Per-user (all of a user's API keys roll up to the same monthly counter, since they share a Stripe subscription). lookups reports the account's monthly lookup cap (record views and people data), a separate counter from API calls.

get/api/v1/account/usage

Request

  • Base URL: https://propraven.com
  • URL: https://propraven.com/api/v1/account/usage
  • Auth: HTTP bearer

Response

Usage report.

tier'free' | 'starter' | 'pro' | 'scale' | 'api_100k' required
periodstring required
period_startstring required
period_endstring required
calls_usedinteger required
calls_includedinteger required

Plan allotment for the current period.

calls_remaininginteger required
hard_cap_enabledboolean required
auth_sourcestring required
hard_cappedboolean

Whether further calls will be hard-rejected vs allowed-and-billed.

Changes

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