OpenMeter

https://openmeter.io/docs
Admin
OpenMeter is a usage-based billing and metering platform that helps developers track and bill for...
Tokens:47,440
Snippets:592
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Node.js SDK

Source: https://openmeter.io/docs/api

Command to install the OpenMeter JavaScript SDK via npm.

```bash
npm install --save @openmeter/sdk
```

--------------------------------

### Install TypeScript SDK

Source: https://openmeter.io/docs/api

Command to install the OpenMeter v3 TypeScript SDK.

```bash
npm install @openmeter/client
```

--------------------------------

### State Change Event Example

Source: https://openmeter.io/docs/metering/guides/common-examples

Example array of events representing a workflow creation and a subsequent success event.

```json
[
  {
    "specversion": "1.0",
    "type": "workflow_create",
    "id": "00001",
    "time": "2024-01-01T00:00:00.001Z",
    "source": "task-queue",
    "subject": "task-1",
    "data": {
      "type": "image-generate"
    }
  },
  {
    "specversion": "1.0",
    "type": "workflow_success",
    "id": "00001",
    "time": "2024-01-01T00:00:00.001Z",
    "source": "task-queue",
    "subject": "task-1",
    "data": {
      "task_type": "image-generate"
    }
  }
]
```

--------------------------------

### Install Kubernetes Collector via Helm

Source: https://openmeter.io/docs/collectors/kubernetes

Use this command to install the collector in the openmeter-collector namespace using the latest version from the OCI registry.

```bash
# Set your OpenMeter token
export OPENMETER_TOKEN=om_...

# Get the latest version or visit https://github.com/openmeterio/openmeter/pkgs/container/helm-charts%2Fbenthos-collector
export LATEST_VERSION=$(curl -s https://api.github.com/repos/openmeterio/openmeter/releases/latest | jq -r '.tag_name' | cut -c 2-)

# Install the collector in the openmeter-collector namespace
helm upgrade openmeter-collector oci://ghcr.io/openmeterio/helm-charts/benthos-collector \
  --version=${LATEST_VERSION} \
  --install --wait --create-namespace \
  --namespace openmeter-collector \
  --set fullnameOverride=openmeter-collector \
  --set openmeter.token=${OPENMETER_TOKEN} \
  --set preset=kubernetes-pod-exec-time
```

--------------------------------

### Kubernetes CloudEvent Example

Source: https://openmeter.io/docs/collectors/kubernetes

Example of a CloudEvent emitted by the OpenMeter Collector representing pod resource usage over a 10-second duration.

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "specversion": "1.0",
  "type": "workload",
  "source": "run_ai",
  "time": "2025-01-01T00:00:00Z",
  "subject": "my-customer-id",
  "data": {
    // Metadata
    "pod_name": "my-pod",
    "pod_namespace": "my-namespace",
    // Pod running for 10 seconds
    "duration_seconds": 10,
    // CPU cores used
    "cpu_request_millicores": 0.5,
    "cpu_request_millicores_per_second": 5,
    // Memory used
    "memory_request_bytes": 4294967296,
    "memory_request_bytes_per_second": 42949672960,
    // GPU
    "gpu_type": "A100",
    "gpu_request_count": 1,
    "gpu_request_count_per_second": 10
  }
}
```

--------------------------------

### Initialize OpenMeter SDK

Source: https://openmeter.io/docs/api

Instructions for installing and initializing the OpenMeter client SDK for both cloud and self-hosted environments.

```APIDOC
## SDK Initialization

### Description
Initialize the OpenMeter client to interact with the API. For cloud usage, provide a base URL and API key; for self-hosted instances, point to the local instance URL.

### Installation (Node.js)
```bash
npm install --save @openmeter/sdk
```

### Initialization Example
```javascript
import { OpenMeter } from '@openmeter/sdk';

const openmeter = new OpenMeter({
  baseUrl: 'https://openmeter.cloud',
  apiKey: '<API_TOKEN>',
});
```
```

--------------------------------

### Start a Subscription

Source: https://openmeter.io/docs/billing/quickstart

Assigns a specific plan to a customer using their ID or key.

```javascript
await openmeter.subscriptions.create({
  customerId: customer.id, // or customerKey
  plan: { key: 'pro' },
});
```

--------------------------------

### GET /

Source: https://openmeter.io/docs/api/v3

Retrieve resources with support for pagination, sorting, and filtering.

```APIDOC
## GET /

### Description
Retrieve a list of resources. Supports pagination, sorting, and filtering via query parameters.

### Method
GET

### Endpoint
/

### Parameters
#### Query Parameters
- **page** (string) - Optional - Page number for pagination
- **sort** (string) - Optional - Sorting criteria
- **filter** (string) - Optional - Filtering criteria
```

--------------------------------

### Multi-Meter Event Example

Source: https://openmeter.io/docs/metering/guides/common-examples

Example event payload containing the union of values and group by fields required by multiple meters.

```json
{
  "specversion": "1.0",
  "type": "request",
  "id": "00001",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "api-service",
  "subject": "customer-1",
  "data": {
    "method": "GET",
    "route": "/products/:product_id",
    "duration_seconds": "123",
    "ingress_bytes": "456",
    "egress_bytes": "789"
  }
}
```

--------------------------------

### Example Event Data

Source: https://openmeter.io/docs/metering/events/event-enrichment

Shows the structure of an event before and after the enrichment process.

```json
{
  "id": "00001",
  "specversion": "1.0",
  "type": "container_duration_miliseconds",
  "source": "worker",
  "subject": "customer-1",
  "time": "2024-01-01T00:00:00.001Z",
  "data": {
    "container_id": "container-1",
    "duration_ms": "1000",
    "cpu_family": "intel",
    "cpu_cores": "4",
    "gpu": "A100-40",
    "gpu_count": "2",
    "mem_mb": "4096"
  }
}
```

```json
{
  "id": "00001",
  "specversion": "1.0",
  "type": "container_duration_miliseconds",
  "source": "worker",
  "subject": "customer-1",
  "time": "2024-01-01T00:00:00.001Z",
  "data": {
    "container_id": "container-1",
    "duration_ms": "1000",
    "cpu_family": "intel",
    "cpu_cores": "4",
    "gpu": "A100-40",
    "gpu_count": "2",
    "mem_mb": "4096",

    "cost": "5.0"
  }
}
```

--------------------------------

### GET /api/v1/addons

Source: https://openmeter.io/docs/api/open-source

Retrieves a list of available add-ons for the system.

```APIDOC
## GET /api/v1/addons

### Description
Lists all available add-ons configured in the system.

### Method
GET

### Endpoint
/api/v1/addons
```

--------------------------------

### Prometheus Counter Metric Example

Source: https://openmeter.io/docs/metering/events/monitoring

Example response format for the openmeter_events_total counter metric.

```text
# HELP openmeter_events Number of ingested events
# TYPE openmeter_events counter
openmeter_events_total{subject="customer-1"} 12345.0
openmeter_events_total{subject="customer-2"} 67890.0
```

--------------------------------

### Install LangChain dependencies

Source: https://openmeter.io/docs/collectors/langchain

Required packages for LangChain integration.

```bash
npm install @langchain/core @langchain/openai
```

--------------------------------

### Nvidia Run:ai CloudEvent Example

Source: https://openmeter.io/docs/collectors/nvidia-run-ai

Example of a CloudEvent emitted by the OpenMeter Collector for a Run:ai workload, showing normalized resource usage metrics.

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "specversion": "1.0",
  "type": "workload",
  "source": "run_ai",
  "time": "2025-01-01T00:00:00Z",
  "subject": "my-customer-id",
  "data": {
    "name": "my-runai-workload",
    "namespace": "my-runai-benchmark-test",
    "phase": "Running",
    "project": "my-project-id",
    "department": "my-department-id",
    // Workload running for a minute
    "workload_minutes": 1.0,
    // 96 CPU cores for a minute (m5a.24xlarge)
    "cpu_limit_core_minutes": 96,
    "cpu_request_core_minutes": 96,
    "cpu_usage_core_minutes": 80,
    // 384 GB of CPU memory for a minute (m5a.24xlarge)
    "cpu_memory_limit_gigabyte_minutes": 384,
    "cpu_memory_request_gigabyte_minutes": 384,
    "cpu_memory_usage_gigabyte_minutes": 178,
    // 1 GPU for a minute
    "gpu_allocation_minutes": 1,
    "gpu_usage_minutes": 1,
    // 40 GB of GPU memory for a minute
    "gpu_memory_request_gigabyte_minutes": 40,
    "gpu_memory_usage_gigabyte_minutes": 27
  }
}
```

--------------------------------

### Initialize and Use v3 TypeScript Client

Source: https://openmeter.io/docs/api

Initialization and usage examples for the v3 client, including meter creation and event ingestion.

```typescript
import { OpenMeter } from '@openmeter/client';

const client = new OpenMeter({
  baseUrl: 'https://openmeter.cloud/api/v3',
  apiKey: process.env.OPENMETER_API_KEY,
});

// Create a meter
const meter = await client.meters.create({
  name: 'Tokens',
  key: 'tokens',
  aggregation: 'sum',
  eventType: 'request',
  valueProperty: '$.tokens',
});

// Ingest a usage event (CloudEvents)
await client.events.ingest({
  id: 'evt-00001',
  source: 'my-service',
  type: 'request',
  subject: 'customer-1',
  data: { tokens: '123456', model: 'gpt-4' },
});
```

--------------------------------

### Install OpenMeter via Helm

Source: https://openmeter.io/docs/open-source/kubernetes

Deploys the OpenMeter chart from the GitHub Container Registry with default configurations, including Kafka and ClickHouse.

```bash
helm upgrade --install openmeter oci://ghcr.io/openmeterio/helm-charts/openmeter
```

--------------------------------

### GET /

Source: https://openmeter.io/docs/api/open-source

Retrieves resources based on the provided query parameters.

```APIDOC
## GET /

### Description
Retrieves a list of resources with support for filtering, pagination, and sorting.

### Method
GET

### Endpoint
/

### Parameters
#### Query Parameters
- **includeDeleted** (boolean) - Optional - Whether to include deleted items.
- **id** (string) - Optional - Filter by ID.
- **key** (string) - Optional - Filter by key.
- **keyVersion** (string) - Optional - Filter by key version.
- **status** (string) - Optional - Filter by status.
- **currency** (string) - Optional - Filter by currency.
- **page** (integer) - Optional - Page number for pagination.
- **pageSize** (integer) - Optional - Number of items per page.
- **order** (string) - Optional - Sort order (ASC/DESC).
- **orderBy** (string) - Optional - Field to sort by.
```

--------------------------------

### API v3 Client Usage

Source: https://openmeter.io/docs/api

Examples for using the v3 SDK to create meters and ingest usage events.

```APIDOC
## API v3 SDK Operations

### Description
Use the v3 SDK to perform resource management and event ingestion. The client handles authentication via Bearer tokens.

### Create a Meter
```javascript
const meter = await client.meters.create({
  name: 'Tokens',
  key: 'tokens',
  aggregation: 'sum',
  eventType: 'request',
  valueProperty: '$.tokens',
});
```

### Ingest Usage Event
```javascript
await client.events.ingest({
  id: 'evt-00001',
  source: 'my-service',
  type: 'request',
  subject: 'customer-1',
  data: { tokens: '123456', model: 'gpt-4' },
});
```

### List Resources
```javascript
for await (const meter of client.meters.listAll()) {
  console.log(meter.key);
}
```
```

--------------------------------

### GET /api/v1/addons

Source: https://openmeter.io/docs/api/cloud

Retrieves a list of available add-ons for the OpenMeter Cloud environment.

```APIDOC
## GET /api/v1/addons

### Description
Retrieves a list of available add-ons for the OpenMeter Cloud environment.

### Method
GET

### Endpoint
/api/v1/addons
```

--------------------------------

### CloudEvent Example

Source: https://openmeter.io/docs/metering/events/usage-events

A sample CloudEvent payload used to report usage data to OpenMeter.

```json
{
  "specversion": "1.0",
  "type": "request",
  "id": "00001",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "service-0",
  "subject": "customer-1",
  "data": {
    "duration_seconds": "10",
    "method": "GET",
    "route": "/hello"
  }
}
```

```json
{
  "specversion": "1.0",
  "type": "request",
  "id": "00002",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "service-0",
  "subject": "customer-1",
  "data": {
    "duration_seconds": "20",
    "method": "GET",
    "route": "/hello"
  }
}
```

--------------------------------

### Install OpenMeter Collector via Helm

Source: https://openmeter.io/docs/collectors/buffer

Use Helm to deploy the OpenMeter Collector with storage and HTTP server presets enabled.

```bash
# Set your OpenMeter token
export OPENMETER_TOKEN=om_...

# Get the latest version or visit https://github.com/openmeterio/openmeter/pkgs/container/helm-charts%2Fbenthos-collector
export LATEST_VERSION=$(curl -s https://api.github.com/repos/openmeterio/openmeter/releases/latest | jq -r '.tag_name' | cut -c 2-)

# Install the collector in the openmeter-collector namespace
helm upgrade openmeter-collector oci://ghcr.io/openmeterio/helm-charts/benthos-collector \
  --version=${LATEST_VERSION} \
  --install --wait --create-namespace \
  --namespace openmeter-collector \
  --set fullnameOverride=openmeter-collector \
  --set openmeter.token=${OPENMETER_TOKEN} \
  --set service.enabled=true \
  --set storage.enabled=true \
  --set preset=http-server
```

--------------------------------

### Define a Meter Configuration

Source: https://openmeter.io/docs/metering/events/usage-events

Example configuration for a meter that sums duration values from events grouped by method and route.

```yaml
meters:
  - slug: api_requests_total
    description: API Requests
    eventType: request
    valueProperty: $.duration_seconds
    aggregation: SUM
    groupBy:
      method: $.method
      route: $.route
```

--------------------------------

### Install OpenMeter dependencies for Next.js

Source: https://openmeter.io/docs/collectors/langchain

Required packages for using OpenMeter with Vercel's AI SDK and LangChain.

```bash
npm install ai @ai-sdk/langchain @langchain/core @langchain/openai
```

--------------------------------

### Start a Subscription After Checkout

Source: https://openmeter.io/docs/billing/quickstart

Creates a subscription for a customer after they have successfully completed the Stripe checkout process.

```javascript
// After redirected to session.successURL
await openmeter.subscriptions.create({
  customerId: session.customerId, // or customerKey
  plan: { key: 'pro' },
});
```

--------------------------------

### Get a Customer by Key

Source: https://openmeter.io/docs/billing/customer/overview

Retrieves an existing customer record using the unique key assigned during creation.

```javascript
const customer = await openmeter.customers.get('my-database-id');
```

--------------------------------

### Example API Gateway Access Log Format

Source: https://openmeter.io/docs/collectors/how-it-works

Represents the raw input format of API gateway logs before transformation.

```json
{
  "timestamp": "2021-01-01T00:00:00.000Z",
  "method": "GET",
  "path": "/app",
  "user": "USERID",
  "duration": 100
}
```

--------------------------------

### List metering events via cURL

Source: https://openmeter.io/docs/api/v3

Example request to retrieve ingested metering events from the local API server.

```Shell
curl http://localhost:8888/api/v3/openmeter/events
```

--------------------------------

### CloudEvents Subject Example

Source: https://openmeter.io/docs/metering/subjects

Example of a CloudEvents payload demonstrating the use of the 'subject' field for metering.

```json
{
  "specversion": "1.0",
  "type": "api-calls",
  "id": "00001",
  "time": "2025-01-01T00:00:00.001Z",
  "source": "my-service",
  "subject": "my-user-id-1",
  "data": {...}
}
```

```json
{
  "specversion": "1.0",
  "type": "api-calls",
  "id": "00002",
  "time": "2023-01-01T00:00:00.001Z",
  "source": "service-0",
  "subject": "customer-1",
  "data": {...}
}
```

--------------------------------

### Create a local Kubernetes cluster with Kind

Source: https://openmeter.io/docs/open-source/kubernetes

Use this command to quickly provision a local Kubernetes cluster for testing purposes.

```bash
kind create cluster
```

--------------------------------

### Unique Count Event Example

Source: https://openmeter.io/docs/metering/guides/common-examples

Example CloudEvents payload for a login event used with the unique sessions meter.

```json
{
  "specversion": "1.0",
  "type": "auth_check",
  "id": "00001",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "auth-service",
  "subject": "customer-1",
  "data": {
    "session_id": "session_id"
  }
}
```

--------------------------------

### Install Collector via Helm

Source: https://openmeter.io/docs/collectors/quickstart

Commands to set the OpenMeter token, retrieve the latest chart version, and deploy the collector using the custom values file.

```bash
 # Set your OpenMeter token
 export OPENMETER_TOKEN=om_...

 # Get the latest version or visit https://github.com/openmeterio/openmeter/pkgs/container/helm-charts%2Fbenthos-collector
 export LATEST_VERSION=$(curl -s https://api.github.com/repos/openmeterio/openmeter/releases/latest | jq -r '.tag_name' | cut -c 2-)

 # Install the collector in the openmeter-collector namespace
 helm upgrade openmeter-collector oci://ghcr.io/openmeterio/helm-charts/benthos-collector \
   --version=${LATEST_VERSION} \
   --install --wait --create-namespace \
   --namespace openmeter-collector \
   --set fullnameOverride=openmeter-collector \
   --set openmeter.token=${OPENMETER_TOKEN} \
   -f ./values.yaml
```

--------------------------------

### Create a Customer

Source: https://openmeter.io/docs/billing/customer/overview

Initializes a new customer record with a name and associated subject keys for usage attribution.

```javascript
const customer = await openmeter.customers.create({
  name: 'ACME, Inc.',
  usageAttribution: { subjectKeys: ['my-identifier'] },
});
```

--------------------------------

### Create a Customer

Source: https://openmeter.io/docs/billing/customer/quickstart

Create a new customer record with usage attribution keys.

```javascript
const customer = await openmeter.customers.create({
  name: 'ACME, Inc.',
  key: 'my-database-id',
  usageAttribution: { subjectKeys: ['my-identifier'] },
});
```

```bash
curl -X POST 'https://openmeter.cloud/api/v1/customers' \
  --header 'Accept: */*' \
  --header 'Authorization: Bearer my-token' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "name": "ACME, Inc.",
    "key": "my-database-id",
    "usageAttribution": { "subjectKeys": ["my-identifier"] }
  }'
```

--------------------------------

### Create a Feature via SDK

Source: https://openmeter.io/docs/product-catalog/feature

Initializes a new feature using a unique key and display name.

```javascript
// Creating a feature via SDK
const feature = await openmeter.features.create({
  key: 'saml_sso',
  name: 'SAML SSO',
});
```

--------------------------------

### Initialize Node.js Client

Source: https://openmeter.io/docs/api

Configuration for the OpenMeter client. For self-hosted instances, omit the API key and update the baseUrl.

```javascript
import { OpenMeter } from '@openmeter/sdk';

const openmeter = new OpenMeter({
  baseUrl: 'https://openmeter.cloud',
  apiKey: '<API_TOKEN>',
});
```

--------------------------------

### API Request Duration Usage Event

Source: https://openmeter.io/docs/metering/guides/common-examples

Example JSON event payload for the api_request_duration meter.

```json
{
  "specversion": "1.0",
  "type": "request",
  "id": "00001",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "api-service",
  "subject": "customer-1",
  "data": {
    "method": "GET",
    "route": "/products/:product_id",
    "duration_seconds": "12345"
  }
}
```

--------------------------------

### Manage and Query Features

Source: https://openmeter.io/docs/product-catalog/feature

Demonstrates archiving, listing, and handling key collisions with archived features.

```javascript
// Archiving a feature via SDK
await openmeter.features.delete('saml_sso');

// Querying all features
const features = await openmeter.features.list({
  includeArchived: false,
});
// => [...], archived feature is not returned

// Trying to create a feature with the same key as an archived one
const feature = await openmeter.features.create({
  key: 'saml_sso',
  name: 'New SAML SSO',
});
// => Success

// Attempting to create an entitlement for the feature
const entitlement = await openmeter.customers.entitlements.create(
  'customer-1',
  {
    type: 'boolean',
    featureId: oldFeature.id,
  },
);
// => Error: Feature not found
```

--------------------------------

### API Request Count Usage Event

Source: https://openmeter.io/docs/metering/guides/common-examples

Example JSON event payload for the api_requests_total meter.

```json
{
  "specversion": "1.0",
  "type": "request",
  "id": "00001",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "api-service",
  "subject": "customer-1",
  "data": {
    "method": "GET",
    "route": "/products/:product_id"
  }
}
```

--------------------------------

### LLM Token Usage Event

Source: https://openmeter.io/docs/metering/guides/common-examples

Example CloudEvents-compliant JSON payload for reporting token usage.

```json
{
  "specversion": "1.0",
  "type": "prompt",
  "id": "00001",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "chat-app",
  "subject": "customer-1",
  "data": {
    "tokens": "123456",
    "provider": "openai",
    "model": "gpt-4o",
    "type": "output"
  }
}
```

--------------------------------

### Create a subscription from a plan

Source: https://openmeter.io/docs/billing/subscription/quickstart

Assigns a pre-defined plan to a customer using the OpenMeter TypeScript SDK.

```typescript
const subscription = await openmeter.subscriptions.create({
  customerId: 'customer-id',
  plan: { key: 'pro' },
});
```

--------------------------------

### Lazy Fetching with AsyncIterable

Source: https://openmeter.io/docs/api

Example of using the listAll method to lazily fetch pages of resources.

```typescript
for await (const meter of client.meters.listAll()) {
  console.log(meter.key);
}
```

--------------------------------

### GET /openmeter/events

Source: https://openmeter.io/docs/api/v3

List ingested metering events with support for filtering, sorting, and cursor-based pagination.

```APIDOC
## GET /openmeter/events

### Description
List ingested events. Events are processed asynchronously by the meters, so they may not be immediately available for querying.

### Method
GET

### Endpoint
/openmeter/events

### Parameters
#### Query Parameters
- **page[size]** (integer) - Optional - The number of items to include per page.
- **page[after]** (string) - Optional - Request the next page of data, starting with the item after this parameter.
- **page[before]** (string) - Optional - Request the previous page of data, starting with the item before this parameter.
- **filter[id]** (string) - Optional - Filter events by ID.
- **filter[source]** (string) - Optional - Filter events by source.
- **filter[subject]** (string) - Optional - Filter events by subject.
- **filter[type]** (string) - Optional - Filter events by type.
- **filter[customer_id]** (string) - Optional - Filter events by the associated customer ID (ULID).
- **filter[time]** (string) - Optional - Filter events by event time (RFC3339).
- **filter[ingested_at]** (string) - Optional - Filter events by the time the event was ingested (RFC3339).
- **filter[stored_at]** (string) - Optional - Filter events by the time the event was stored (RFC3339).
- **sort** (string) - Optional - Sort events returned in the response. Supported attributes: time, ingested_at, stored_at.

### Request Example
curl http://localhost:8888/api/v3/openmeter/events

### Response
#### Success Response (200)
- **data** (array) - List of event objects.
- **meta** (object) - Pagination metadata.

#### Response Example
{
  "data": [
    {
      "event": {
        "id": "5c10fade-1c9e-4d6c-8275-c52c36731d3c",
        "source": "service-name",
        "specversion": "1.0",
        "type": "prompt",
        "subject": "customer_key",
        "time": "2023-01-01T01:01:01.001Z"
      },
      "customer": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      },
      "ingested_at": "2023-01-01T01:01:01.001Z",
      "stored_at": "2023-01-01T01:01:02.001Z"
    }
  ],
  "meta": {
    "page": {
      "first": "string",
      "last": "string",
      "next": null,
      "previous": null,
      "size": 10
    }
  }
}
```

--------------------------------

### Create and Manage Entitlements with OpenMeter SDK

Source: https://openmeter.io/docs/billing/entitlements/entitlement

Initializes the OpenMeter client and demonstrates creating a boolean entitlement. Note that creating an entitlement for a feature key that already exists for a customer will result in an error.

```typescript
import { OpenMeter } from '@openmeter/sdk';

// Connect to locally running OpenMeter instance
const openmeter = new OpenMeter({
  baseUrl: 'http://127.0.0.1:8888',
  // For OpenMeter Cloud use:
  // baseUrl: 'https://openmeter.cloud',
  // apiKey: '<API_TOKEN>',
});

// Create entitlement for customer-1 to use SAML SSO
await openmeter.customers.entitlements.create('customer-1', {
  type: 'boolean',
  featureKey: 'saml_sso',
});

await openmeter.customers.entitlements.create('customer-1', {
  type: 'boolean',
  featureKey: 'saml_sso',
});
// => Error: Entitlement already exists for the feature key 'saml_sso' for customer 'customer-1'
```

--------------------------------

### Kubernetes Pod Execution Duration Usage Event

Source: https://openmeter.io/docs/metering/guides/common-examples

Example JSON event payload for the pod_execution_time meter.

```json
{
  "specversion": "1.0",
  "type": "kube-pod-exec-time",
  "id": "f7f11c82-c415-4325-aec7-572606681817",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "my-app",
  "subject": "customer-1",
  "data": {
    "duration_seconds": "123",
    "pod_name": "pod_name",
    "pod_namespace": "pod_namespace"
  }
}
```

--------------------------------

### GPU Time Usage Event

Source: https://openmeter.io/docs/metering/guides/common-examples

Example CloudEvents-compliant JSON payload for reporting GPU execution duration.

```json
{
  "specversion": "1.0",
  "type": "gpu_time",
  "id": "00001",
  "time": "2024-01-01T00:00:00.001Z",
  "source": "my-image-generator",
  "subject": "customer-1",
  "data": {
    "duration_seconds": "12345",
    "hostname": "my-hostname",
    "region": "us-east-1",
    "gpu_type": "nvidia_A100"
  }
}
```

--------------------------------

### Define a Count Meter

Source: https://openmeter.io/docs/metering/guides/creating-meters

Example configuration for a meter that counts API requests grouped by method and route.

```yaml
meters:
  - slug: api_requests_total
    description: API Requests
    eventType: request
    aggregation: COUNT
    groupBy:
      method: $.method
      route: $.route
```
Tokens:
Raw