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_settings
Every sylphx money usage_settings command: its argument, its flags and a run line.
The usage_settings commands of Sylphx Money, as the CLI spells them: the same
calls as the usage_settings API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets the environment's usage settings.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money usage-settings get orgs/acme/projects/shop/envs/production/usage_settings/usage-settingsGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_settings/usage-settings · scope billing:read · effect read · Request, response and examples
#update
Updates the usage settings, the enforcement switch included. A change is recorded with who made it.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money usage-settings update orgs/acme/projects/shop/envs/production/usage_settings/usage-settings --currency-code …PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_settings/usage-settings · 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. |
--currency-code | string | The currency usage is rated and invoiced in (ISO 4217, upper case). Required. |
--enforcement-enabled | bool | While false a reservation is always granted and a would-be refusal is only recorded. Off until the merchant's admin turns it on. |
--free-allowance-nano | string | What a subject with no payment method may use each month, nano-minor, as a decimal string. |
--past-due-grace-days | int | Days after an invoice's due time before the subject is past due. |
--suspend-grace-days | int | Days after an invoice's due time before the subject is suspended. |
--extra-issuer | string | A further token issuer (the merchant's own OIDC provider) besides Sylphx Auth; empty for Sylphx Auth only. It needs extra_issuer_jwks_url. |
--extra-issuer-jwks-url | string | The issuer's HTTPS JWKS URL. |
--extra-issuer-audience | string | The audience that issuer's tokens must carry; required with extra_issuer. |
--extra-issuer-org-claim | string | The claim that names a customer organization in that issuer's tokens; empty means the issuer proves no organization subject. |