OpenMeter Apps

Apps enable you to extend and customize billing and usage workflows by integrating with external systems and services. Apps can automate and enhance your billing ecosystem by supporting capabilities such as synchronizing usage data with third-party platforms, calculating taxes, generating and delivering invoices, handling payment collection, and other billing-related tasks.

List apps

List installed apps.

get

Query Parameters

pageobject

Determines which page of the collection to retrieve.

Show Child Parameters

Response

application/json

Page paginated response.

AppPagePaginatedResponse

Page paginated response.

dataOne Of
array[object]required

Installed application.

BillingAppStripeobject

Stripe app.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
get/openmeter/apps
 
application/json

Get app

Get an installed app.

get

Path Parameters

appIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

application/json

App response.

BillingApp

BillingAppobject

Installed application.

One Of
idstringrequiredread-only

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

namestringrequired

Display name of the resource.

Between 1 and 256 characters.

>= 1 characters<= 256 characters

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

<= 1024 characters

labelsobject

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, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2023-01-01T01:01:01.001Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity last update date.

Example:2023-01-01T01:01:01.001Z

deleted_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity deletion date.

Example:2023-01-01T01:01:01.001Z

typestringrequiredread-only

The app type.

Allowed values:stripe

definitionobjectrequiredread-only

The app catalog definition that this installed app is based on.

Example:{"type":"stripe","name":"Stripe","description":"Stripe integration allows you to collect payments with Stripe."}

Show Child Parameters
statusstringrequiredread-only

Status of the app connection.

Allowed values:readyunauthorized

account_idstringrequiredread-only

The Stripe account ID associated with the connected Stripe account.

livemodebooleanrequiredread-only

Indicates whether the app is connected to a live Stripe account.

masked_api_keystringrequiredread-only

The masked Stripe API key that only exposes the first and last few characters.

get/openmeter/apps/{appId}
 
application/json

OpenMeter Entitlements

Entitlements are used to control access to features for customers.

List customer entitlement access

get

Path Parameters

customerIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

Match pattern:^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

application/json

List the customer’s active features and their access.

ListCustomerEntitlementAccessResponseData

List customer entitlement access response data.

dataarray[object]requiredread-only

Entitlement access result.

Show Child Parameters
get/openmeter/customers/{customerId}/entitlement-access
 
application/json