API
SE Visible / Subscription
Subscription
The Subscription API returns SE Visible subscription plan and its current usage limits for your organisation. Use it to check your plan, billing period, and how many projects, prompts, and user seats you have left before you create new resources.
Using the SE Visible API, you can:
- read your organisation’s subscription plan and status
- check the billing period, renewal date, and auto-renew setting
- see the
max,used, andavailablecounts for projects, prompts, and user seats
All endpoints are relative to the base URL https://api.seranking.com/v1/se-visible.
Get subscription details
GET https://api.seranking.com/v1/se-visible/subscription
Returns the authenticated user’s organisation subscription and current usage limits. This is organisation-level, not project-scoped.
Request parameters
This endpoint takes no parameters.
Request example
curl -X GET 'https://api.seranking.com/v1/se-visible/subscription' \
-H 'Authorization: Token YOUR_API_KEY'Response parameters
If successful, the server returns the subscription object.
| Parameter | Type | Description |
|---|---|---|
| plan_key | String | Subscription plan key (e.g. pro). |
| status | String | Subscription status (e.g. active). |
| created_at | String | Subscription creation datetime. |
| ends_at | String | Subscription end datetime. |
| billing_period | String or null | Billing period (e.g. monthly), or null if not set. |
| auto_renew | Boolean | Whether the subscription renews automatically. |
| limits | Object | Usage limits for the subscription. |
| limits.projects.max | Integer or null | Maximum number of projects allowed by the plan; null when unlimited is true. |
| limits.projects.used | Integer | Number of projects currently in use. |
| limits.projects.available | Integer or null | Number of projects remaining; null when unlimited is true, otherwise never below 0. |
| limits.projects.unlimited | Boolean | true when the plan does not cap projects; max and available are then null. |
| limits.prompts.max | Integer or null | Maximum number of prompts allowed by the plan; null when unlimited is true. |
| limits.prompts.used | Integer | Number of prompts currently in use. |
| limits.prompts.available | Integer or null | Number of prompts remaining; null when unlimited is true, otherwise never below 0. |
| limits.prompts.unlimited | Boolean | true when the plan does not cap prompts; max and available are then null. |
| limits.user_seats.max | Integer or null | Maximum number of user seats allowed by the plan; null when unlimited is true. |
| limits.user_seats.used | Integer | Number of user seats currently in use. |
| limits.user_seats.available | Integer or null | Number of user seats remaining; null when unlimited is true. Otherwise max - used without clamping, so it is negative when active users exceed the seat limit. |
| limits.user_seats.unlimited | Boolean | true when the plan does not cap user seats; max and available are then null. |
| limits.locations_per_project | Object | Cap on tracked locations, applied to each project separately, so it has no used or available. |
| limits.locations_per_project.max | Integer or null | Maximum number of locations per project; null when unlimited is true. |
| limits.locations_per_project.unlimited | Boolean | true when the plan does not cap locations per project. |
| limits.web_engines | Object | Cap on browser (web scraping) engines a project can track, applied to each project separately. |
| limits.web_engines.max | Integer or null | Maximum number of web engines per project; null when unlimited is true. |
| limits.web_engines.unlimited | Boolean | true when the plan does not cap web engines per project. |
| limits.api_engines | Object | Cap on API engines a project can track, applied to each project separately. |
| limits.api_engines.max | Integer or null | Maximum number of API engines per project; null when unlimited is true. |
| limits.api_engines.unlimited | Boolean | true when the plan does not cap API engines per project. |
Note:
- SE Visible usage is governed by these plan limits (projects, prompts, user seats, and the per-project caps on locations and engines), not by per-request credits.
- Prompts are counted in prompt scenarios: one per prompt per tracked location. A prompt tracked in 3 locations consumes 3. Engines and the prompt’s language do not multiply it.
Response example
{
"plan_key": "pro",
"status": "active",
"created_at": "2026-01-15 10:30:00",
"ends_at": "2026-02-15 10:30:00",
"billing_period": "monthly",
"auto_renew": true,
"limits": {
"projects": {
"max": 5,
"used": 2,
"available": 3,
"unlimited": false
},
"prompts": {
"max": 450,
"used": 120,
"available": 330,
"unlimited": false
},
"user_seats": {
"max": 3,
"used": 1,
"available": 2,
"unlimited": false
},
"locations_per_project": {
"max": 1,
"unlimited": false
},
"web_engines": {
"max": 6,
"unlimited": false
},
"api_engines": {
"max": 0,
"unlimited": false
}
}
}
