Skip to content
Docs

List FOCUS contract commitments

GEThttps://api.vercel.com/v1/billing/contract-commitments
Returns commitment allocations per contract period in FOCUS v1.3 JSONL format for a specified Vercel team. The response is streamed as newline-delimited JSON (JSONL). This endpoint is only applicable to Enterprise Vercel customers. An empty response is returned for non-Enterprise (Pro/Flex) customers.
https://api.vercel.com/v1/billing/contract-commitments
const response = await fetch('https://api.vercel.com/v1/billing/contract-commitments?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
{
  "ContractCommitmentCategory": "Spend",
  "ContractCommitmentCost": "123",
  "ContractCommitmentDescription": "string",
  "ContractCommitmentId": "example_id",
  "ContractCommitmentPeriodStart": "string",
  "ContractCommitmentPeriodEnd": "string",
  "ContractCommitmentQuantity": "1",
  "ContractCommitmentType": "string",
  "ContractCommitmentUnit": "units",
  "ContractId": "example_id",
  "ContractPeriodStart": "string",
  "ContractPeriodEnd": "string",
  "BillingCurrency": "string"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

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

Response

200Success
ContractCommitmentCategorystringRequired
Highest-level classification of the contract commitment. 'Spend' for Pro ($20/month), 'Usage' for Enterprise (MIU allocation).
ContractCommitmentCostnumberOptional
Monetary value of the contract commitment (in BillingCurrency). Required when ContractCommitmentCategory is 'Spend'. For Pro: 20 (USD)
ContractCommitmentDescriptionstringOptional
Self-contained summary of the contract commitment's terms
ContractCommitmentIdstringRequired
Unique identifier for a single contract term within a contract. Maps to specific commitment period or allocation ID.
ContractCommitmentPeriodStartstringRequired
Inclusive start of the commitment term period (ISO 8601 UTC)
ContractCommitmentPeriodEndstringRequired
Exclusive end of the commitment term period (ISO 8601 UTC)
ContractCommitmentQuantitynumberOptional
Amount associated with the commitment (in ContractCommitmentUnit). Required when ContractCommitmentCategory is 'Usage'. For Enterprise: MIU allocation amount.
ContractCommitmentTypestringRequired
Service-provider-assigned name identifying the commitment type. 'Pro' or 'Enterprise' for Vercel.
ContractCommitmentUnitstringRequired
Measurement unit for ContractCommitmentQuantity. 'MIUs' for Enterprise, 'USD' for Pro spend commitments.
ContractIdstringRequired
Service-provider-assigned identifier for a contract. Maps to Orb Subscription ID for Vercel.
ContractPeriodStartstringRequired
Inclusive start of the overall contract period (ISO 8601 UTC)
ContractPeriodEndstringRequired
Exclusive end of the overall contract period (ISO 8601 UTC)
BillingCurrencystringRequired

Errors

400Error
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error