Skip to content
Docs

Update Installation

Optional
PATCH/v1/installations/{installationId}
Update an installation
Needed if customers can upgrade or downgrade their billing plan on an existing installation. Vercel sends the new billing plan ID in the request body and authenticates with user authentication.
/v1/installations/{installationId}
const response = await fetch('/v1/installations/installationId', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "billingPlanId": "example_id"
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "billingPlan": {
    "id": "icfg_1234567890",
    "type": "prepayment",
    "name": "Example Name",
    "scope": "installation",
    "description": "string",
    "paymentMethodRequired": "true",
    "preauthorizationAmount": "123",
    "initialCharge": "string",
    "minimumAmount": "100.00",
    "maximumAmount": "100.00",
    "maximumAmountAutoPurchasePerPeriod": "100.00",
    "cost": "string",
    "details": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "highlightedDetails": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "quote": [
      {
        "line": "string",
        "amount": "100.00"
      }
    ],
    "effectiveDate": "2024-01-01T00:00:00Z",
    "disabled": "true"
  },
  "notification": {
    "level": "info",
    "title": "string",
    "message": "string",
    "href": "https://example.com"
  }
}
Errors
{
  "error": {
    "code": "validation_error",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    },
    "fields": [
      {
        "key": "string",
        "message": "string"
      }
    ]
  }
}

Authentication

AuthorizationUser Authentication

Default authentication mechanism

Path parameters

installationIdstringRequired

Header parameters

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

Request

This endpoint expects an object.

billingPlanIdstringOptional
Partner-provided billing plan. Example: "pro200"

Response

200The 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.
204The installation was updated successfully

Errors

400Input has failed validation
errorobjectRequired
403Operation failed because the authentication is not allowed to perform this operation
errorobjectRequired
409Operation failed because of a conflict with the current state of the resource
errorobjectRequired
Update Installation | Partner API