List integration billing plans

APIs & SDKs

GET/__remote/api.vercel.com/v1/integrations/integration/{integrationIdOrSlug}/products/{productIdOrSlug}/plans

Get a list of billing plans for an integration and product.

/__remote/api.vercel.com/v1/integrations/integration/{integrationIdOrSlug}/products/{productIdOrSlug}/plans

const response = await fetch('/__remote/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": [
    {
      "cost": "string",
      "description": "string",
      "details": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "disabled": "false",
      "effectiveDate": "string",
      "highlightedDetails": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "id": "icfg_1234567890",
      "initialCharge": "string",
      "maximumAmount": "100.00",
      "maximumAmountAutoPurchasePerPeriod": "100.00",
      "minimumAmount": "100.00",
      "name": "Example Name",
      "paymentMethodRequired": "false",
      "preauthorizationAmount": "123",
      "quote": [
        {
          "amount": "100.00",
          "line": "string"
        }
      ],
      "scope": "installation",
      "type": "prepayment"
    }
  ]
}

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

/__remote/api.vercel.com/v1/integrations/integration/{integrationIdOrSlug}/products/{productIdOrSlug}/plans

const response = await fetch('/__remote/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": [
    {
      "cost": "string",
      "description": "string",
      "details": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "disabled": "false",
      "effectiveDate": "string",
      "highlightedDetails": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "id": "icfg_1234567890",
      "initialCharge": "string",
      "maximumAmount": "100.00",
      "maximumAmountAutoPurchasePerPeriod": "100.00",
      "minimumAmount": "100.00",
      "name": "Example Name",
      "paymentMethodRequired": "false",
      "preauthorizationAmount": "123",
      "quote": [
        {
          "amount": "100.00",
          "line": "string"
        }
      ],
      "scope": "installation",
      "type": "prepayment"
    }
  ]
}

OpenAPI Specification