Skip to main content
GET
Get the current plan explanation for an inverter

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

org_id
string<uuid>
required

The organization ID of the user's organization

user_id
string<uuid>
required

The user ID of the user whom the inverter belongs to

inverter_id
string<uuid>
required

The ID of the specified inverter

Query Parameters

language
string | null

Optional language code (e.g. 'de') overriding the organization's default language

Response

200 - application/json
ExplainerOutput · object | null

OK

The wire shape every device-type explainer endpoint serves.

id
string<uuid>
required

Durable identifier of this explanation, used to dismiss it or rate it.

explanation
string
required

The customer-facing narrative, in the resolved language.

feedback
ExplainerFeedbackOutput · object | null
required

The requesting user's own rating of this explanation, or null when they have not rated it.