GET/me

Get Account Info

Retrieve account information, plan details, and usage statistics

Scope: FORMS_READ

Overview

Returns account-level information including the current plan, AI credit balance, storage usage, and API call quota. Useful for building dashboards or monitoring usage programmatically.

Request

GET/me

Headers

HeaderValue
AuthorizationBearer fxk_live_<your-api-key>

Example Request

curl -X GET "https://api.formfex.com/api/v1/public/me" \
  -H "Authorization: Bearer $FORMFEX_API_KEY"

Response

Response Fields

FieldTypeDescription
data.planstringCurrent subscription plan (free, starter, pro, business)
data.aiCreditsRemainingnumberRemaining AI credits for the current billing period
data.aiFormsGeneratednumberNumber of AI-generated forms created
data.ragUploadsUsednumberNumber of RAG document uploads used
data.storageBytesUsednumberTotal file storage used in bytes
data.apiCalls.usednumberAPI calls consumed in the current period
data.apiCalls.limitnumberMaximum API calls allowed per period
data.apiCalls.resetsAtstringISO 8601 timestamp when the API call quota resets

Monitor Your Usage

Poll this endpoint periodically to track credit consumption and avoid hitting quota limits. The apiCalls.resetsAt field tells you when your monthly quota refreshes.