List FOCUS 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.

GET /v1/billing/contract-commitments

listContractCommitments

TypeScript

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.billing.listContractCommitments({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  for await (const event of result) {
    // Handle the event
    console.log(event);
  }
}

run();

200

{
  "ContractCommitmentCategory": "Usage",
  "ContractCommitmentId": "<string>",
  "ContractCommitmentPeriodStart": "<string>",
  "ContractCommitmentPeriodEnd": "<string>",
  "ContractCommitmentType": "<string>",
  "ContractCommitmentUnit": "<string>",
  "ContractId": "<string>",
  "ContractPeriodStart": "<string>",
  "ContractPeriodEnd": "<string>",
  "BillingCurrency": "<string>",
  "ContractCommitmentCost": 123,
  "ContractCommitmentDescription": "<string>",
  "ContractCommitmentQuantity": 123
}

Authorizations

Authorization · string · header · required

Default authentication mechanism

Query Parameters

teamId · string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

slug · string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Response

200

application/jsonl

Contract commitment information describing terms within a contract. New in FOCUS v1.3 - tracks commitment terms separate from cost/usage rows. For Vercel: - Pro: $20 monthly spend commitment - Enterprise: MIU allocation per period (usage commitment)

ContractCommitmentCategory · enum<string> · required

Highest-level classification of the contract commitment. 'Spend' for Pro ($20/month), 'Usage' for Enterprise (MIU allocation).

Available options: Usage, Spend

ContractCommitmentId · string · required

Unique identifier for a single contract term within a contract. Maps to specific commitment period or allocation ID.

ContractCommitmentPeriodStart · string · required

Inclusive start of the commitment term period (ISO 8601 UTC)

ContractCommitmentPeriodEnd · string · required

Exclusive end of the commitment term period (ISO 8601 UTC)

ContractCommitmentType · string · required

Service-provider-assigned name identifying the commitment type. 'Pro' or 'Enterprise' for Vercel.

ContractCommitmentUnit · string · required

Measurement unit for ContractCommitmentQuantity. 'MIUs' for Enterprise, 'USD' for Pro spend commitments.

ContractId · string · required

Service-provider-assigned identifier for a contract. Maps to Orb Subscription ID for Vercel.

ContractPeriodStart · string · required

Inclusive start of the overall contract period (ISO 8601 UTC)

ContractPeriodEnd · string · required

Exclusive end of the overall contract period (ISO 8601 UTC)

BillingCurrency · string · required

ContractCommitmentCost · number

Monetary value of the contract commitment (in BillingCurrency). Required when ContractCommitmentCategory is 'Spend'. For Pro: 20 (USD)

ContractCommitmentDescription · string

Self-contained summary of the contract commitment's terms

ContractCommitmentQuantity · number

Amount associated with the commitment (in ContractCommitmentUnit). Required when ContractCommitmentCategory is 'Usage'. For Enterprise: MIU allocation amount.