GET/v1/usage
Usage
Returns a snapshot of your current plan along with how many posts, profiles, and analytics credits you've used. Use this endpoint to drive in-app credit indicators in your developer dashboard, or to decide whether to show an upgrade prompt to your end user before calling another endpoint that might fail with a quota error.
Request
curl https://api.synposter.com/v1/usage \
-H "x-api-key: YOUR_API_KEY"| Header | Required | Description |
|---|---|---|
| x-api-key | Yes | Your API key |
Response
| Field | Type | Description |
|---|---|---|
| plan | string | Current plan: free, starter, growth, or scale |
| posts.used | integer | Number of posts used this period |
| posts.limit | integer | null | Posts allowed on your plan. null means unlimited. |
| posts.remaining | integer | null | Posts remaining this period. null if unlimited. |
| profiles.used | integer | Number of profiles you currently have |
| profiles.limit | integer | null | Profiles allowed on your plan. null means unlimited. |
| profiles.remaining | integer | null | Profiles you can still create. null if unlimited. |
| analytics.used | integer | Analytics credits consumed this period. Each call to GET /v1/analytics costs 1 credit. |
| analytics.limit | integer | null | Analytics credits allowed on your plan. null means unlimited. |
| analytics.remaining | integer | null | Analytics credits remaining this period. null if unlimited. |
| periodStart | string | ISO 8601 timestamp of period start |
| periodEnd | string | null | ISO 8601 timestamp of period end. Null for free tier. |
json
{
"plan": "free",
"posts": {
"used": 3,
"limit": 20,
"remaining": 17
},
"profiles": {
"used": 1,
"limit": 1,
"remaining": 0
},
"analytics": {
"used": 12,
"limit": 100,
"remaining": 88
},
"periodStart": "2026-04-01T00:00:00Z",
"periodEnd": null
}Status Codes
| 200 | Success |
| 401 | Missing or invalid API key |
| 500 | Internal error reading usage data |