Get Usage

Return the caller's current monthly usage, plan, and quota.

All figures are in properties returned, not API calls: a search that returns 10 properties consumes 10 units of quota.

used_this_month is reservation-inclusive: when a POST /v1/properties submits with max_items=N, all N slots are counted immediately and the unused portion is refunded when the job completes. This means the number can settle downward over the course of a billing period.

Authentication is required but quota is not enforced, so callers can always retrieve their own usage even after exceeding their limit.

get/v1/usage

Request

  • Base URL: https://api.apillow.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.apillow.co/v1/usage
  • Auth: none declared

Response

Successful Response

planstring required

Current plan: 'free', 'pro', 'ultra', 'mega'

monthly_limitinteger required

Included monthly quota for the plan, in properties returned. Usage is counted per property, not per API call.

used_this_monthinteger required

Properties returned this period. Reservation-inclusive: counts in-flight jobs at their submitted max_items and settles downward as jobs complete and unused portions are refunded.

remaininginteger required

monthly_limit minus used_this_month, floored at 0. For paid plans with overages, additional properties beyond this are billed at overage_rate_per_1k.

overage_countinteger required

Properties returned beyond monthly_limit in the current period. 0 unless used_this_month > monthly_limit on a paid plan with overages.

overage_rate_per_1knumber nullable required

USD price per 1,000 overage properties ($5.00 = $0.005 per property). Null for free / grandfathered hard-capped plans.

billing_period_startstring required

ISO 8601 UTC start of the current quota period (subscription billing date for paid plans; 1st of the calendar month for free keys).

billing_period_endstring required

ISO 8601 UTC end of the current quota period (1st of the next calendar month, exclusive).

Changes

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