Skip to main content
PUT
/
v1
/
usage
/
{id}
Node.js
import { PriceOS } from "priceos";
import type { MyFeatures } from "./priceos.types";

const priceos = new PriceOS<MyFeatures>(process.env.PRICEOS_API_KEY!);

const result = await priceos.usage.updateEvent({
  id: "event_123",
  amount: 2,
  metadata: {
    source: "admin_tool",
  },
});
{
  "id": "<string>",
  "amount": 123,
  "occurredAt": 123,
  "source": "usage",
  "eventKey": "<string>",
  "metadata": {}
}

Headers

​
x-api-key
string
required

API key from your PriceOS dashboard.

Path Parameters

​
id
string<uuid>
required

Usage event ID.

Body

application/json
​
amount
number

Optional updated usage amount.

​
occurredAt
integer

Optional updated Unix timestamp (ms) when the event occurred.

​
eventKey
string | null

Stable unique identifier for this event. Reuse it on retries and for deduplication. Use null to clear.

​
metadata
object

Optional updated metadata (string key/value pairs). Use null to clear.

Response

Usage event updated

Updated usage event.

​
id
string
required

Usage event ID.

​
amount
number
required

Usage amount recorded.

​
occurredAt
integer
required

Unix timestamp (ms) when the event occurred.

​
source
enum<string>
required

Usage event source.

Available options:
usage,
usage_set_adjustment
​
eventKey
string | null

Stable unique identifier for this event. Reuse it on retries and for deduplication.

​
metadata
object

Event metadata (string key/value pairs).