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 Subscriptions API

Subscriptions are used to track usage of your product or service. Subscriptions can be individuals or organizations that can subscribe to plans and have access to features.

Kong OpenMeter Subscriptions 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 Subscriptions. 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 6 operations across 5 paths, and defines 25 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}.

6 operations 5 paths 25 schemas 2 GET4 POST

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 Subscriptions 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 6

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

OpenMeter Subscriptions 6

Subscriptions are used to track usage of your product or service. Subscriptions can be individuals or organizations that can subscribe to plans and have access to features.

POST
/v3/openmeter/subscriptions
Create subscription
create-subscription body → 201400401403404409
GET
/v3/openmeter/subscriptions
List subscriptions
list-subscriptions 2 params → 200400401403404
GET
/v3/openmeter/subscriptions/{subscriptionId}
Get subscription
get-subscription 1 param → 200400401403404
POST
/v3/openmeter/subscriptions/{subscriptionId}/cancel
Cancel subscription
cancel-subscription 1 param body → 200400401403404409
POST
/v3/openmeter/subscriptions/{subscriptionId}/change
Change subscription
change-subscription 1 param body → 200400401403404409
POST
/v3/openmeter/subscriptions/{subscriptionId}/unschedule-cancelation
Unschedule subscription cancelation
unschedule-cancelation 1 param → 200400401403404409

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are BillingSubscription (9 properties), BillingSubscriptionChange (5 properties), InvalidParameterMinimumLength (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
ConflictError
InvalidParameterChoiceItem
object
5 properties 4 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
BillingSubscriptionChangeResponse
object
Response for changing a subscription.
2 properties 2 required
BillingSubscriptionCancel
object
Request for canceling a subscription.
1 property
BillingSubscriptionEditTimingEnum
string
Subscription edit timing. When immediate, the requested changes take effect immediately. When nextbillingcycle, the requested changes take effect at the next b…
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
BillingSubscriptionChange
object
Request for changing a subscription.
5 properties 3 required
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
DateTime
string
[RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in UTC.
SubscriptionPagePaginatedResponse
object
Page paginated response.
2 properties 2 required
ULID
string
ULID (Universally Unique Lexicographically Sortable Identifier).
BillingSubscriptionCreate
object
Subscription create request.
4 properties 2 required
BillingSubscription
object
Subscription.
9 properties 6 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-subscriptions-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