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

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

Kong OpenMeter Customers 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 Customers. 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 10 operations across 6 paths, and defines 33 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}.

10 operations 6 paths 33 schemas 1 DELETE3 GET3 POST3 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 Customers 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 10

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

OpenMeter Customers 10

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

POST
/v3/openmeter/customers
Create customer
create-customer body → 201400401403
GET
/v3/openmeter/customers
List customers
list-customers 3 params → 200400401403
GET
/v3/openmeter/customers/{customerId}
Get customer
get-customer 1 param → 200400401403404
PUT
/v3/openmeter/customers/{customerId}
Upsert customer
upsert-customer 1 param body → 200400401403404410
DELETE
/v3/openmeter/customers/{customerId}
Delete customer
delete-customer 1 param → 204400401403404
GET
/v3/openmeter/customers/{customerId}/billing
Get customer billing data
get-customer-billing 1 param → 200400401403404
PUT
/v3/openmeter/customers/{customerId}/billing
Update customer billing data
update-customer-billing 1 param body → 200400401403404410
PUT
/v3/openmeter/customers/{customerId}/billing/app-data
Update customer billing app data
update-customer-billing-app-data 1 param body → 200400401403404410
POST
/v3/openmeter/customers/{customerId}/billing/stripe/checkout-sessions
Create Stripe Checkout Session
create-customer-stripe-checkout-session 1 param body → 201400401403404410
POST
/v3/openmeter/customers/{customerId}/billing/stripe/portal-sessions
Create Stripe customer portal session
create-customer-stripe-portal-session 1 param body → 201400401403404410

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are BillingAppStripeCreateCheckoutSessionResult (17 properties), BillingCustomer (12 properties), BillingAppStripeCreateCustomerPortalSessionResult (8 properties), CreateCustomerRequest (8 properties). Each schema is shown below with its type and property counts.

ExternalResourceKey
string
ExternalResourceKey is a unique string that is used to identify a resource in an external system.
InvalidParameterMinimumLength
object
5 properties 4 required
BillingCustomerStripeCreateCustomerPortalSessionRequest
object
Request to create a Stripe Customer Portal Session for the customer. Useful to redirect the customer to the Stripe Customer Portal to manage their payment meth…
1 property 1 required
BillingAppStripeCreateCheckoutSessionResult
object
Result of creating a Stripe Checkout Session. Contains all the information needed to redirect customers to the checkout or initialize an embedded checkout flow.
17 properties 6 required
BillingCustomer
object
Customers can be individuals or organizations that can subscribe to plans and have access to features.
12 properties 5 required
CustomerPagePaginatedResponse
object
Page paginated response.
2 properties 2 required
BillingCustomerStripeCreateCheckoutSessionRequest
object
Request to create a Stripe Checkout Session for the customer. Checkout Sessions are used to collect payment method information from customers in a secure, Stri…
1 property 1 required
ListCustomersParamsFilter
object
Filter options for listing customers.
3 properties
InvalidParameterChoiceItem
object
5 properties 4 required
BillingAppCustomerData
object
App customer data.
2 properties
InvalidParameterMaximumLength
object
5 properties 4 required
UsageAttributionSubjectKey
string
Subject key.
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
BillingCustomerData
object
Billing customer data.
2 properties
CreateCustomerRequest
object
Customer create request.
8 properties 2 required
PaginatedMeta
object
returns the pagination information
1 property 1 required
UpsertAppCustomerDataRequest
object
AppCustomerData upsert request.
2 properties
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
SortQuery
string
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provi…
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
UpsertCustomerRequest
object
Customer upsert request.
7 properties 1 required
ULID
string
ULID (Universally Unique Lexicographically Sortable Identifier).
GoneError
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
BillingAppStripeCreateCustomerPortalSessionResult
object
Result of creating a [Stripe Customer Portal Session](https://docs.stripe.com/api/customerportal/sessions/object). Contains all the information needed to redir…
8 properties 8 required
UpsertCustomerBillingDataRequest
object
CustomerBillingData upsert request.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-openmeter-customers-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