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
sylphx money usage_meters
Every sylphx money usage_meters command: its argument, its flags and a run line.
The usage_meters commands of Sylphx Money, as the CLI spells them: the same
calls as the usage_meters API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a usage meter.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money usage-meters get orgs/acme/projects/shop/envs/production/usage_meters/usage-meterGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_meters/usage-meter · scope billing:read · effect read · Request, response and examples
#list
Lists usage meters.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx money usage-meters list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_meters · scope billing:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
#update
Creates or updates a usage meter. The unit cannot change once it has recorded usage.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money usage-meters update orgs/acme/projects/shop/envs/production/usage_meters/usage-meter --unit …PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_meters/usage-meter · scope billing:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--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. |