Update meter

Updates a usage meter. The eventName, aggregation, and settlement fields become immutable once any usage event has been reported against the meter. Rate fields remain editable. Requires the METERS_WRITE scope.

Authorization

AuthorizationBearer <token>

Bearer token authentication. Pass the secret directly in the Authorization header. Token secrets start with sk_.

In: header

Path Parameters

storeId*string

Length12 <= length <= 48

productId*string

Length12 <= length <= 48

meterId*string

Length12 <= length <= 48

Header Parameters

idempotency-key?string

Length8 <= length <= 32

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

eventName?string

Match^[a-zA-Z0-9_.-]+$

Length1 <= length <= 64

unitPrice?integer

Range0 <= value <= 100000000

unitQuantity?integer

Range1 <= value <= 1000000000

aggregation?|||

settlement?|

includedUnits?|null

Response Body

`application/json`

curl -X PATCH "https://example.com/stores/stringstring/products/stringstring/meters/stringstring" \  -H "Content-Type: application/json" \  -d '{}'

{  "ok": true,  "data": {    "id": "umt_5e1q3npwt0u6s2k8h9j7rzbc",    "productId": "prd_8h4t6sqzy3x9w5n2k1m0vqbf",    "eventName": "input_tokens",    "unitPrice": 300,    "unitQuantity": 1000000,    "aggregation": "SUM",    "settlement": "ARREARS",    "includedUnits": null,    "createdAt": "2026-05-20T14:00:00.000Z",    "updatedAt": "2026-05-20T14:00:00.000Z"  }}

Update meter

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

404application/json

409application/json

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`