Skip to main content
GET
Get Usage
Credits: 0.

Overview

Returns API usage for the current billing period, broken down by metered endpoint type, plus the per-endpoint-type requests-per-minute limits your plan enforces. by_endpoint_type reports used, beta_used, limit and limit_source for each metered endpoint type. used is credits actually spent from your organization’s pooled balance. beta_used is the nominal value of requests that ran free because the action is in beta; it is reported separately and is never part of used. limit is null and limit_source is pooled: every endpoint type draws on one shared credit balance, so there is no per-type allowance. See Get Credits for the balance, grant, and reset date. A bucket marked gated: true is not included in your plan: once traffic bills under that endpoint type, those requests are refused with 403 plan_gated before any credits are spent. Requires the billing:read scope.

Response

string
Always usage.
integer[]
Sorted distinct credit schedule versions present in this billing period’s billable events (1 = the pre-launch placeholder weights, 2 = the credit schedule at signa.so/pricing). Empty when the period has no billable events; two entries mean the period spans a schedule change, so per-request credits are not comparable across it. See schema_version on List Request Logs for the per-request value.
object
object
object
Requests-per-minute limit per endpoint type (search, read, screening, monitoring, utility, reference, and the metered action types: compute, reconcile, fees_estimate, gs_draft, gs_validate, class_suggest, class_lookup, rules_lookup, analytics, market_analytics), as enforced by the rate limiter. See Rate Limits for how limits are applied.
string
Unique request identifier for support and debugging.

Code Examples