API Description

Account & system

subscription

This command returns information on existing subscriptions along with the current API balance for the authenticated API key.

Request Parameters: subscription

ParameterData TypeMandatoryDefault ValueDescriptionAcceptable valuesExample
outputstringnojsonOutput formatjson, xmljson

GET Request

To receive information about the subscription

Title of the code block
Copy
curl -X GET 'https://api.seranking.com/v1/account/subscription?output=json' \
-H 'Authorization: Token YOUR_API_KEY'

Response Parameters: subscription

ParameterData TypeDescriptionExample
statusstringCurrent status of the API subscription plan. One of: active, inactive, expired, disabled.active
start_datedatetimeSubscription start date in “YYYY-MM-DD HH:MM:SS” format.2025-05-07 15:10:27
expiration_datedatetimeSubscription expiration date in “YYYY-MM-DD HH:MM:SS” format.2026-05-07 15:10:27
units_limitlongQuota (total number of API units) for this subscription50000000
units_leftlongCurrent API balance, i.e. number of API units left.123546

Sample Request: subscription

Title of the code block
Copy
curl -X GET 'https://api.seranking.com/v1/account/subscription' \
-H 'Authorization: Token YOUR_API_KEY'

Sample Response: subscription

Title of the code block
Copy
{
  "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
  }
}