API
Account and subscription
Subscription
GET
https://api.seranking.com/v1/account/subscription
Cost: 0 credits
Return information about existing subscriptions and the remaining API balance for the authenticated API key.
Request parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| output | String | No | json | Response format. Possible values: json (default) or xml. |
Request example
curl -X GET 'https://api.seranking.com/v1/account/subscription?output=json' \
-H 'Authorization: Token YOUR_API_KEY'
Response parameters
| Parameter | Type | Description |
|---|---|---|
| status | String | Current status of the API subscription plan: active, inactive, expired, or disabled. |
| start_date | DateTime | Subscription start date in YYYY-MM-DD HH:MM:SS format. |
| expiration_date | DateTime | Subscription expiration date in YYYY-MM-DD HH:MM:SS format. |
| units_limit | Long | Total number of API units available for this subscription. |
| units_left | Long | Current API balance — number of remaining API units. |
Response example
{
"subscription_info": {
"status": "active",
"start_date": "2024-01-18 14:20:02",
"expiraton_date": "2024-02-18 14:20:02",
"units_limit": 5000000,
"units_left": 4975033
}
}
