Skip to main content
GET
/
api
/
v1
/
subscription
Get subscription and quota status
curl --request GET \
  --url https://api.fetchin.io/api/v1/subscription \
  --header 'X-API-Key: <api-key>'
{
  "plan": "custom",
  "active": true,
  "status": "active",
  "creditsRemaining": 184230,
  "creditsLimit": 250000,
  "creditsUsed": 65770,
  "renewalDate": "2026-07-15T00:00:00.000Z",
  "rpsLimit": 20,
  "cancelAtPeriodEnd": false
}

​
Endpoint

GET /api/v1/subscription
Read your account’s current subscription state programmatically so you can confirm access before routing traffic and detect a billing issue before it interrupts your integration.

​
Authentication

Include your API key in the request header: 
X-API-Key: your-api-key-here

​
Parameters

None. The account is identified by your API key.

​
Response

​
plan
string
Plan identifier, e.g. "free" or "custom".
​
active
boolean
Whether the subscription is in good standing. false when the billing status is past_due, incomplete, canceled or unpaid. This flag is about billing only — check creditsRemaining separately to know whether you still have credits.
​
status
string
Raw billing status. Branch your integration on this value. free and active are good standing; past_due / incomplete / unpaid indicate a payment problem; canceled means the subscription has ended; trialing is a trial period.
​
creditsRemaining
number
Credits left in the current billing period.
​
creditsLimit
number
Total credits allotted for the current billing period.
​
creditsUsed
number
Credits consumed so far in the current billing period.
​
renewalDate
string
When the current period ends and credits renew (ISO 8601), e.g. "2026-07-15T00:00:00.000Z".
​
rpsLimit
number
Maximum sustained requests per second for this account.
​
cancelAtPeriodEnd
boolean
Whether the subscription is set to end at the current period’s end (i.e. it will not renew).

​
Example Request

curl -X GET "https://api.fetchin.io/api/v1/subscription" \
  -H "X-API-Key: your-api-key-here"

​
Example Response

{
  "plan": "custom",
  "active": true,
  "status": "active",
  "creditsRemaining": 184230,
  "creditsLimit": 250000,
  "creditsUsed": 65770,
  "renewalDate": "2026-07-15T00:00:00.000Z",
  "rpsLimit": 20,
  "cancelAtPeriodEnd": false
}

​
Errors

See Error Handling for the full list of error codes and recommended handling.
  • 401 UNAUTHENTICATED / INVALID_API_KEY
  • 429 RATE_LIMITED
  • 500 INTERNAL_ERROR
  • 503 SERVICE_UNAVAILABLE

​
Notes

This endpoint is free — it does not consume credits. It also returns 200 even when your quota is exhausted, so you can always use it to diagnose why calls are failing.
To decide whether you can call a data endpoint right now, check active && creditsRemaining > 0. Poll this endpoint periodically (not on every request) — the numbers reflect our billing store and may lag real-time usage by a few seconds.

​
Use Cases

Multi-provider arbitrage

Route traffic based on remaining credits and RPS across providers

Uninterrupted access

Detect a non-payment (past_due) or scheduled cancellation before it blocks you

Usage monitoring

Track credit consumption and renewal timing programmatically

Capacity planning

Confirm your effective RPS limit before scaling up request volume

Authorizations

​
X-API-Key
string
header
required

Response

Current subscription and quota status

​
plan
string
required

Plan identifier (e.g. "free", "custom").

Example:

"custom"

​
active
boolean
required

Whether the subscription is in good standing. False when the billing status is past_due, incomplete, canceled or unpaid. Note: a false value here means a billing issue; check creditsRemaining separately to know if you still have credits.

Example:

true

​
status
enum<string>
required

Raw billing status. Branch on this rather than the HTTP status. free and active are good standing; past_due/incomplete/unpaid indicate a payment problem; canceled means the subscription has ended.

Available options:
active,
free,
trialing,
past_due,
incomplete,
unpaid,
canceled
Example:

"active"

​
creditsRemaining
integer
required

Credits left in the current billing period.

Example:

184230

​
creditsLimit
integer
required

Total credits allotted for the current billing period.

Example:

250000

​
creditsUsed
integer
required

Credits consumed so far in the current billing period.

Example:

65770

​
renewalDate
string<date-time>
required

When the current period ends and credits renew (ISO 8601).

Example:

"2026-07-15T00:00:00.000Z"

​
rpsLimit
integer
required

Maximum sustained requests per second for this account.

Example:

20

​
cancelAtPeriodEnd
boolean
required

Whether the subscription is set to end at the current period's end (no renewal).

Example:

false