Get meter

Get a meter by ID.

get

Path Parameters

meterIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

application/json

Meter response.

Meter

A meter is a configuration that defines how to match and aggregate events.

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

keystringrequired

A key is a unique string that is used to identify a resource.

Match pattern:^[a-z0-9]+(?:_[a-z0-9]+)*$

>= 1 characters<= 64 characters

Example:resource_key

aggregationstringrequired

The aggregation type to use for the meter.

Allowed values:sumcountunique_countavgminmaxlatest

event_typestringrequired

The event type to include in the aggregation.

>= 1 characters

Example:prompt

events_fromstring(date-time)

The date since the meter should include events.
Useful to skip old events.
If not specified, all historical events are included.

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

value_propertystring

JSONPath expression to extract the value from the ingested event’s data property.

The ingested value for sum, avg, min, and max aggregations is a number or a string that can be parsed to a number.

For unique_count aggregation, the ingested value must be a string. For count aggregation the value_property is ignored.

>= 1 characters

Example:$.tokens

dimensionsobject

Named JSONPath expressions to extract the group by values from the event data.

Keys must be unique and consist only alphanumeric and underscore characters.

Example:{"type":"$.type"}

get/openmeter/meters/{meterId}
 
application/json

Delete meter

Delete a meter.

delete

Path Parameters

meterIdstringrequired

ULID (Universally Unique Lexicographically Sortable Identifier).

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

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

Deleted response.

delete/openmeter/meters/{meterId}
 

AppPagePaginatedResponse

object

Page paginated response.

dataOne Of
array[object]required

Installed application.

BillingAppStripeobject

Stripe app.

Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

BillingApp

object

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.

Example

BillingAppCustomerData

object

App customer data.

stripeobject

Used if the customer has a linked Stripe app.

Show Child Parameters
external_invoicingobject

Used if the customer has a linked external invoicing app.

Show Child Parameters
Example