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

Prev Next
Get
/customer/company-subscription/status

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/company-subscription/status 

Authorization:

Bearer {API token}

Prerequisites 
  • You must have an API token associated with your account.
Things to know 
  • Calls to this endpoint are free of charge.
  • You can test the endpoint directly in the API console on the right.
Security
HTTP
Type bearer

Enter your Solargis TMY Bearer token.

Responses
200

Subscription details

Expand All
object

Details about the authenticated user, their company, and active subscriptions.

user
object

Personal details of the authenticated user.

firstName
string

User's first name.

middleName
string

User's middle name.

lastName
string

User's last name.

email
string

User's email address associated with the Solargis account.

company
object

Company details associated with the subscription.

sgCompanyId
string

Unique Solargis internal identifier for the company.

name
string

Registered company name.

subscriptions
Array of object

List of active and past subscriptions associated with the company.

object
id
string

Unique identifier of the subscription.

validFrom
string (date-time)

Date and time from which the subscription is valid.

validTo
string (date-time)

Date and time at which the subscription expires.

type
string

Subscription tier or product type (e.g., PRO, ENTERPRISE).

consumptionActive
boolean

Indicates whether the subscription is currently consuming request quota.

totalRequests
integer

Total number of data requests allowed under the subscription.

pendingRequests
integer

Number of data requests currently queued or processing.

finishedRequests
integer

Number of data requests that have been successfully completed.

name
string

Human-readable name or label of the subscription plan.

401

Invalid authorization

object

Invalid authorization

error
string

Machine-readable error code indicating the authentication failure reason.

Exampletoken.invalid