Menu

Update Installation

PATCH/v1/installations/{installationId}
Update an installation
/v1/installations/{installationId}
const response = await fetch('/v1/installations/string', {
method: 'PATCH',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"billingPlanId": "string"
}),
});
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"
}
}
AuthorizationUser Authentication

Default authentication mechanism

installationIdstringRequired
X-Vercel-AuthstringOptional
The auth style used in the request (system, user, etc)
Idempotency-KeystringOptional
A unique key to identify a request across multiple retries

This endpoint expects an object.

billingPlanIdstringOptional
Partner-provided billing plan. Example: "pro200"
The installation was updated successfully
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.
400Input has failed validation
403Operation failed because the authentication is not allowed to perform this operation
409Operation failed because of a conflict with the current state of the resource
Update Installation | Partner API