API

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, and available counts 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`).
has_external_subscription	Boolean	Whether the subscription is managed by an external system.
created_at	String	Subscription creation datetime.
ends_at	String	Subscription end datetime.
external_subscription_id	String or null	External subscription identifier, or `null` if none.
is_external_plan	Boolean	Whether the plan is provisioned by an external system.
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	Maximum number of projects allowed by the plan.
limits.projects.used	Integer	Number of projects currently in use.
limits.projects.available	Integer	Number of projects remaining.
limits.prompts.max	Integer	Maximum number of prompts allowed by the plan.
limits.prompts.used	Integer	Number of prompts currently in use.
limits.prompts.available	Integer	Number of prompts remaining.
limits.user_seats.max	Integer	Maximum number of user seats allowed by the plan.
limits.user_seats.used	Integer	Number of user seats currently in use.
limits.user_seats.available	Integer	Number of user seats remaining.

Note:

SE Visible usage is governed by these plan limits (projects, prompts, and user seats), not by per-request credits.

Response example

{
  "plan_key": "pro",
  "status": "active",
  "has_external_subscription": false,
  "created_at": "2026-01-15 10:30:00",
  "ends_at": "2026-02-15 10:30:00",
  "external_subscription_id": null,
  "is_external_plan": false,
  "billing_period": "monthly",
  "auto_renew": true,
  "limits": {
    "projects": {
      "max": 5,
      "used": 2,
      "available": 3
    },
    "prompts": {
      "max": 450,
      "used": 120,
      "available": 330
    },
    "user_seats": {
      "max": 3,
      "used": 1,
      "available": 2
    }
  }
}