Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Jobs and cron
Localization
Monitoring
Notifications
Payments
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Update an usage meter
Creates or updates a usage meter.
Creates or updates a usage meter. The unit cannot change once it has recorded usage.
- Path
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_meters/usage-meter - Scope
billing:write - Effect
write— a successful call changes state. - Collection usage_meters
- Query
update_mask
#Request
| Field | Type | What it is |
|---|---|---|
usage_meter | UsageMeter | The usage meter with its new values; name selects it. Required. |
update_mask | field_mask | The fields to change. |
#UsageMeter
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/usage_meters/{usage_meter}; the id is the meter key. |
meta | ResourceMeta | Resource metadata. |
unit | string | The unit of one quantity, for example token. It cannot change once the meter has recorded usage. Required. |
display_name | string | A name for people. |
reservation_optional | bool | Whether usage may be recorded without a reservation. |
active | bool | A retired meter (false) refuses new usage; its history stays. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/usage_meters/{usage_meter}; the id is the meter key. |
uid | string | umtr_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
unit | string | The unit of one quantity, for example token. It cannot change once the meter has recorded usage. Required. |
display_name | string | A name for people. |
reservation_optional | bool | Whether usage may be recorded without a reservation. |
active | bool | A retired meter (false) refuses new usage; its history stays. |
current_unit_price_nano | string | The unit price in force now, nano-minor, a decimal string; empty before the meter's first price. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.INVALID_STATE— The Resource is in a state that forbids the call.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_meters/usage-meter" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"orgs/acme/projects/shop/envs/production/usage_meters/usage-meter","unit":"…"}'