{
"openapi": "3.0.2",
"info": {
"title": "Klaviyo API (Beta)",
"version": "2026-07-15.pre",
"description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.",
"contact": {
"name": "Klaviyo Developer Experience Team",
"email": "developers@klaviyo.com",
"url": "https://developers.klaviyo.com"
},
"termsOfService": "https://www.klaviyo.com/legal/api-terms",
"license": {
"name": "License",
"url": "https://www.klaviyo.com/legal"
}
},
"servers": [
{
"url": "https://a.klaviyo.com",
"description": "Production"
}
],
"security": [
{
"Klaviyo-API-Key": []
}
],
"paths": {
"/api/billing-usage/{id}": {
"get": {
"operationId": "get_billing_usage_beta",
"summary": "Get Billing Usage",
"description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet current-period usage and plan cap for a single usage type.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`usage:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_billing_usage_beta.json)",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The usage type to retrieve.",
"required": true,
"schema": {
"description": "The usage type to retrieve.",
"type": "string",
"example": "email_sends"
}
},
{
"name": "fields[billing-usage]",
"in": "query",
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"as_of",
"id",
"period_end",
"period_start",
"unit",
"usage_max",
"usage_used"
]
}
},
"explode": false
},
{
"name": "revision",
"in": "header",
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"required": true,
"schema": {
"type": "string",
"default": "2026-07-15.pre"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetBillingUsageResponse"
}
}
}
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"tags": [
"Beta APIs"
],
"x-klaviyo-pre-release": "BETA",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"usage:read"
],
"x-klaviyo-subtag": "Billing"
}
}
},
"components": {
"responses": {
"ClientError": {
"description": "Client Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
},
"ServerError": {
"description": "Server Error",
"content": {
"application/vnd.api+json": {
"schema": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"code",
"title",
"detail"
],
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"title": {
"type": "string"
},
"detail": {
"type": "string"
},
"source": {
"type": "object",
"properties": {
"pointer": {
"type": "string"
},
"parameter": {
"type": "string"
}
}
}
}
}
}
},
"required": [
"errors"
]
}
}
}
}
},
"schemas": {
"AgentHints": {
"description": "Optional hints emitted by the API for agent callers",
"type": "object",
"properties": {
"next_steps": {
"description": "Suggested follow-up actions for agents to take after this response",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"BillingUsageEnum": {
"type": "string",
"enum": [
"billing-usage"
]
},
"BillingUsageResponseObjectResource": {
"type": "object",
"properties": {
"type": {
"$ref": "#/components/schemas/BillingUsageEnum"
},
"id": {
"description": "The usage type this row reports on.",
"type": "string",
"example": "email_sends"
},
"attributes": {
"type": "object",
"properties": {
"usage_used": {
"description": "Amount consumed against this usage type in the current period, rounded to 4 decimal places.",
"type": "number",
"example": 180000
},
"usage_max": {
"description": "Maximum usage allowed for this usage type on the current plan.",
"type": "integer",
"example": 250000
},
"unit": {
"description": "The unit usage_used and usage_max are denominated in.",
"type": "string",
"example": "messages",
"enum": [
"CAD",
"USD",
"conversations",
"credits",
"messages",
"orders",
"profiles",
"resolutions"
]
},
"period_start": {
"description": "Start of the current billing period for this usage type, in UTC.",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00"
},
"period_end": {
"description": "Exclusive end of the current billing period for this usage type, in UTC. Usage is counted up to but not including this instant.",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00"
},
"as_of": {
"description": "When this row's usage_used was read, in UTC.",
"type": "string",
"format": "date-time",
"example": "2022-11-08T00:00:00+00:00"
}
},
"required": [
"usage_used",
"usage_max",
"unit",
"period_start",
"period_end",
"as_of"
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"type",
"id",
"attributes",
"links"
]
},
"GetBillingUsageResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BillingUsageResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"meta": {
"$ref": "#/components/schemas/ResponseMeta"
}
},
"required": [
"data"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"ResponseMeta": {
"description": "Response-level metadata",
"type": "object",
"properties": {
"agent_hints": {
"$ref": "#/components/schemas/AgentHints"
}
}
}
},
"securitySchemes": {
"Klaviyo-API-Key": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Beta APIs",
"description": "beta apis"
}
]
}