> ## Documentation Index
> Fetch the complete documentation index at: https://kb.solargis.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get subscription details
## OpenAPI
````json GET /customer/customer-subscription/status
{
"openapi": "3.0.3",
"info": {
"title": "Solargis API documentation",
"version": "2.1.1",
"description": "Explore Solargis API endpoints and learn how to retrieve TimeSeries, TMY, and other data from your Solargis subscriptions."
},
"servers": [
{
"url": "https://api.solargis.com",
"description": "TimeSeries and TMY API endpoint"
}
],
"tags": [
{
"name": "Solargis Time Series API",
"description": "Endpoints for Time Series data requests"
},
{
"name": "Solargis TMY API",
"description": "Endpoints for TMY data requests"
},
{
"name": "Subscription details API",
"description": "Get information about your subscription"
}
],
"paths": {
"/customer/customer-subscription/status": {
"get": {
"tags": [
"Subscription details API"
],
"summary": "Get subscription details",
"security": [
{
"TMYToken": []
}
],
"responses": {
"200": {
"description": "Subscription details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionStatusResponse"
}
}
}
},
"401": {
"description": "Invalid authorization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvalidToken"
}
}
}
}
},
"x-d360-narrative-url": "Use this endpoint to retrieve your account and subscription information, including your registered name and email, subscription ID, validity dates, and API request history.
Request type: | GET |
URL: | https://api.solargis.com/customer/customer-subscription/status |
Authorization: | Bearer {API token} |
Prerequisites
Things to know
"
}
}
},
"components": {
"schemas": {
"SubscriptionStatusResponse": {
"type": "object",
"description": "Details about the authenticated user, their company, and active subscriptions.",
"properties": {
"user": {
"type": "object",
"description": "Personal details of the authenticated user.",
"properties": {
"firstName": {
"type": "string",
"description": "User's first name."
},
"middleName": {
"type": "string",
"description": "User's middle name."
},
"lastName": {
"type": "string",
"description": "User's last name."
},
"email": {
"type": "string",
"description": "User's email address associated with the Solargis account."
}
}
},
"customer": {
"type": "object",
"description": "Company details associated with the subscription.",
"properties": {
"sgCustomerId": {
"type": "string",
"description": "Unique Solargis internal identifier for the company."
},
"name": {
"type": "string",
"description": "Registered company name."
}
}
},
"subscriptions": {
"type": "array",
"description": "List of active and past subscriptions associated with the company.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the subscription."
},
"validFrom": {
"type": "string",
"format": "date-time",
"description": "Date and time from which the subscription is valid."
},
"validTo": {
"type": "string",
"format": "date-time",
"description": "Date and time at which the subscription expires."
},
"type": {
"type": "string",
"description": "Subscription tier or product type (e.g., PRO, ENTERPRISE)."
},
"consumptionActive": {
"type": "boolean",
"description": "Indicates whether the subscription is currently consuming request quota."
},
"totalRequests": {
"type": "integer",
"description": "Total number of data requests allowed under the subscription."
},
"pendingRequests": {
"type": "integer",
"description": "Number of data requests currently queued or processing."
},
"finishedRequests": {
"type": "integer",
"description": "Number of data requests that have been successfully completed."
},
"name": {
"type": "string",
"description": "Human-readable name or label of the subscription plan."
}
}
}
}
}
},
"InvalidToken": {
"type": "object",
"description": "Invalid authorization",
"properties": {
"error": {
"type": "string",
"description": "Machine-readable error code indicating the authentication failure reason.",
"example": "token.invalid"
}
}
}
},
"securitySchemes": {
"TMYToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Enter your Solargis TMY Bearer token.\n"
}
}
}
}
````