Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong OpenMeter Billing API

Billing manages the billing profiles, currencies, cost bases, and invoices for customers.

Kong OpenMeter Billing API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include OpenMeter Billing. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 5 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.

Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.

5 operations 2 paths 24 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong OpenMeter Billing API declares 1 security scheme for authenticating requests. An API key is passed in the header as Kong-Admin-Token (adminToken). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

OpenMeter Billing 5

Billing manages the billing profiles, currencies, cost bases, and invoices for customers.

GET
/v3/openmeter/profiles
List billing profiles
list-billing-profiles 1 param → 200400401403
POST
/v3/openmeter/profiles
Create a new billing profile
create-billing-profile body → 201400401403
GET
/v3/openmeter/profiles/{id}
Get a billing profile
get-billing-profile 1 param → 200400401403404
PUT
/v3/openmeter/profiles/{id}
Update a billing profile
update-billing-profile 1 param body → 200400401403404
DELETE
/v3/openmeter/profiles/{id}
Delete a billing profile
delete-billing-profile 1 param → 204400401403404

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are BillingProfile (11 properties), CreateBillingProfileRequest (7 properties), UpsertBillingProfileRequest (6 properties), InvalidParameterMinimumLength (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
BillingProfilePagePaginatedResponse
object
Page paginated response.
2 properties 2 required
BillingWorkflowCollectionAlignmentAnchored
object
BillingWorkflowCollectionAlignmentAnchored specifies the alignment for collecting the pending line items into an invoice.
2 properties 2 required
InvalidParameterChoiceItem
object
5 properties 4 required
BillingProfile
object
Billing profiles contain the settings for billing and controls invoice generation.
11 properties 8 required
InvalidParameterMaximumLength
object
5 properties 4 required
Labels
object
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters,…
ForbiddenError
UnauthorizedError
BillingWorkflowPaymentSendInvoiceSettings
object
Payment settings for a billing workflow when the collection method is send invoice.
2 properties 1 required
PaginatedMeta
object
returns the pagination information
1 property 1 required
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
CreateBillingProfileRequest
object
BillingProfile create request.
7 properties 5 required
InvalidParameterStandard
object
4 properties 2 required
BillingWorkflowPaymentChargeAutomaticallySettings
object
Payment settings for a billing workflow when the collection method is charge automatically.
1 property 1 required
BillingWorkflowCollectionAlignmentSubscription
object
BillingWorkflowCollectionAlignmentSubscription specifies the alignment for collecting the pending line items into an invoice.
1 property 1 required
ULID
string
ULID (Universally Unique Lexicographically Sortable Identifier).
UpsertBillingProfileRequest
object
BillingProfile upsert request.
6 properties 4 required
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-openmeter-billing-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API