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
On this page
sylphx money usage_events
Every sylphx money usage_events command: its argument, its flags and a run line.
The usage_events commands of Sylphx Money, as the CLI spells them: the same
calls as the usage_events API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#create
Records usage directly, only for a meter the merchant marked reservation-optional.
CLI
sylphx money usage-events create --parent orgs/acme/projects/shop/envs/production --subject-proof … --meter … --quantity 1POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_events · scope billing:metering:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--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. |
--subject.end-user | string | An end user's id (Sylphx Auth, or the app's own OIDC issuer). |
--subject.customer-organization | string | A customer organization's id. |
--subject-proof | string | As on UsageReservation. Required. |
--actor-proof | string | As on UsageReservation. |
--meter | string | The meter's lookup key. Required. |
--quantity | int | How much, in the meter's base unit. Required. |
--occurred-time | timestamp | When the work happened. Required. |
#list
Lists usage events, newest first.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx money usage-events list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_events · 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. |
--filter | string | AIP-160 filter, for example subject = "…". |
#check-standing
Reads a subject's standing: active, past due or suspended, whether a payment method is on file, headroom and the threshold.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money usage-events check-standing orgs/acme/projects/shop/envs/productionPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_events:checkStanding · scope billing:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--subject | json | Whose standing. Required. |
--subject-proof | string | As on UsageReservation: a verified token for the subject. Required. |
--actor-proof | string | For a customer organization: the acting user's token. |