Skip to content
Docs

List Billing Plans For Resource

Optional
GET/v1/installations/{installationId}/resources/{resourceId}/plans
Returns the set of billing plans available to a specific Resource
Needed if your integration supports plan changes for existing resources. Vercel calls this endpoint with system authentication to populate the plan-selection UI when a user changes a resource's billing plan.
/v1/installations/{installationId}/resources/{resourceId}/plans
const response = await fetch('/v1/installations/installationId/resources/resourceId/plans?metadata=string', {
  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": "validation_error",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    },
    "fields": [
      {
        "key": "string",
        "message": "string"
      }
    ]
  }
}

Authentication

AuthorizationSystem Authentication

Default authentication mechanism

Path parameters

installationIdstringRequired
resourceIdstringRequired

Query parameters

metadatastringOptional

Header parameters

X-Vercel-AuthstringOptional
The auth style used in the request (system, user, etc)

Response

200Return a list of billing plans for a resource
plansarrayRequired

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
List Billing Plans For Resource | Partner API