Menu

Get Installation

GET/v1/installations/{installationId}
Get an installation
/v1/installations/{installationId}
const response = await fetch('/v1/installations/string', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);
Response
{
"billingPlan": {
"id": "string",
"type": "prepayment",
"name": "string",
"scope": "installation",
"description": "string",
"paymentMethodRequired": "true",
"preauthorizationAmount": "123",
"initialCharge": "string",
"minimumAmount": "string",
"maximumAmount": "string",
"maximumAmountAutoPurchasePerPeriod": "string",
"cost": "string",
"details": [],
"highlightedDetails": [],
"quote": [],
"effectiveDate": "string",
"disabled": "true"
},
"notification": {
"level": "info",
"title": "string",
"message": "string",
"href": "string"
}
}
AuthorizationSystem Authentication

Default authentication mechanism

installationIdstringRequired
X-Vercel-AuthstringOptional
The auth style used in the request (system, user, etc)
The installation
billingPlanobjectOptional
The billing plan for the installation. If not set, the installation is billed on resource level.
notificationobjectOptional
Installation's active notification. Example: { "level": "warn", "title": "Account is exceeding the maximum allowed storage no the current plan" }. Return null to remove any current installation notification.
403Operation failed because the authentication is not allowed to perform this operation
Get Installation | Partner API