APIs & SDKs

GEThttps://api.vercel.com/v1/billing/charges

Vercel SDK

List FOCUS billing charges

Returns the billing charge data in FOCUS v1.3 JSONL format for a specified Vercel team, within a date range specified by from and to query parameters. Supports 1-day granularity with a maximum date range of 1 year. The response is streamed as newline-delimited JSON (JSONL) and can be optionally compressed with gzip if the Accept-Encoding: gzip header is provided. This is only available for Owner, Member, Developer, Security, Billing, and Enterprise Viewer roles for the supplied team.

Authentication

AuthorizationbearerToken

Default authentication mechanism

from

string

to

The Team identifier to perform the request on behalf of.

Required

The Team slug to perform the request on behalf of.

Inclusive start of the date range as an ISO 8601 date-time string in UTC.

teamId

slug

string

Optional

Exclusive end of the date range as an ISO 8601 date-time string in UTC.

Response

200Success

BilledCost

BillingCurrency

number

string

Required

Classification of the charge

ChargeCategory

Currency used for billing (ISO 4217)

Charge amount serving as the basis for invoicing

Required

string

ChargePeriodEnd

Exclusive end of the charge period (ISO 8601 UTC) - Required in v1.3

ChargePeriodStart

Volume of resource consumed. Null when a charge does not involve measurable consumption quantity.

Required

string

Required

string

ConsumedQuantity

Unit of measurement for consumed quantity. Null when the charge is not measured in units.

number

Required

string

Inclusive start of the charge period (ISO 8601 UTC)

EffectiveCost

Amortized cost representation including discounts, pre-commitment credit purchase amount, etc.

Required

ConsumedUnit

Required

number

PricingUnit

PricingCategory

PricingCurrency

RegionName string

RegionId

+Show 1 enum values

Pricing model used for the charge.
PricingQuantity
string
string

string

Display name for the region number

Optional

+Show 4 enum values

Required
Required
Required
Provider-assigned region identifier
Required

Optional

ServiceCategory

High-level category of the service

ServiceName

Display name for the service/product

string

Entity making the resource/service available for purchase (v1.3)

Optional

Required

ServiceProviderName

object

string

Required

Charge metadata including the Vercel ProjectId and ProjectName information

Errors

400One of the provided values in the request query is invalid.

410Error

500Error

404Error

503Error

401The request is not authorized.

403You do not have permission to access this resource.