Skip to content
Console
Menu

Generated Assets

Workflows

Getting Started

Authentication

KV Store

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

Shell
sylphx money usage-events create --parent orgs/acme/projects/shop/envs/production --subject-proof … --meter … --quantity 1

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_events · scope billing:metering:write · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--subject.end-userstringAn end user's id (Sylphx Auth, or the app's own OIDC issuer).
--subject.customer-organizationstringA customer organization's id.
--subject-proofstringAs on UsageReservation. Required.
--actor-proofstringAs on UsageReservation.
--meterstringThe meter's lookup key. Required.
--quantityintHow much, in the meter's base unit. Required.
--occurred-timetimestampWhen 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

Shell
sylphx money usage-events list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_events · scope billing:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-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

Shell
sylphx money usage-events check-standing orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_events:checkStanding · scope billing:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--subjectjsonWhose standing. Required.
--subject-proofstringAs on UsageReservation: a verified token for the subject. Required.
--actor-proofstringFor a customer organization: the acting user's token.