List Billing Plans For Installation

APIs & SDKs

Optional

GET/v1/installations/{installationId}/plans

Returns the set of billing plans available to a specific Installation

Required when Supports Installation Billing Plans is enabled in the Integration Console. Vercel calls this endpoint with system authentication to get available plans for an existing installation, powering the plan-selection UI.

/v1/installations/{installationId}/plans

const response = await fetch('/v1/installations/installationId/plans', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "plans": [
    {
      "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"
    }
  ]
}

Errors

{
  "error": {
    "code": "forbidden",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    }
  }
}

Authentication

AuthorizationSystem Authentication

Default authentication mechanism

Path parameters

installationIdstringRequired

Header parameters

X-Vercel-AuthstringOptional

The auth style used in the request (system, user, etc)

Response

200Return a list of billing plans for an installation

plansarrayRequired

Errors

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

Related Vercel documentation

This page is not in the current cross-link map.

/v1/installations/{installationId}/plans

const response = await fetch('/v1/installations/installationId/plans', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "plans": [
    {
      "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"
    }
  ]
}

Errors

{
  "error": {
    "code": "forbidden",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    }
  }
}

OpenAPI Specification