SIsignificant-gravitas
v2
admin
copilot
admin

Get User Rate Limit

Changed on

Get a user's current usage and effective rate limits. Admin-only.

Accepts either user_id or email as a query parameter. When email is provided the user is looked up by email first.

get/api/copilot/admin/rate_limit

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

user_idstring nullable
emailstring nullable

Response

Successful Response

user_idstring required
user_emailstring nullable
daily_cost_limit_microdollarsinteger required
weekly_cost_limit_microdollarsinteger required
daily_cost_used_microdollarsinteger required
weekly_cost_used_microdollarsinteger required
tier'NO_TIER' | 'TRIAL' | 'BASIC' | 'PRO' | 'MAX' | 'BUSINESS' | 'ENTERPRISE' required

Subscription tiers with increasing cost allowances.

Mirrors the SubscriptionTier enum in schema.prisma. Once prisma generate is run, this can be replaced with::

from prisma.enums import SubscriptionTier
tier_multipliersobject

Changes