Skip to content
Docs

List integration billing plans

GEThttps://api.vercel.com/v1/integrations/integration/{integrationIdOrSlug}/products/{productIdOrSlug}/plans
Get a list of billing plans for an integration and product.
https://api.vercel.com/v1/integrations/integration/{integrationIdOrSlug}/products/{productIdOrSlug}/plans
const response = await fetch('https://api.vercel.com/v1/integrations/integration/integrationIdOrSlug/products/productIdOrSlug/plans?integrationConfigurationId=string&metadata=string&source=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "plans": [
    {
      "type": "prepayment",
      "id": "icfg_1234567890",
      "name": "Example Name",
      "scope": "installation",
      "description": "string",
      "paymentMethodRequired": "false",
      "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": "string",
      "disabled": "false"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

integrationIdOrSlugstringRequired
productIdOrSlugstringRequired

Query parameters

integrationConfigurationIdstringOptional
metadatastringOptional
sourcestringOptional
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
plansarrayRequired

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error