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
Get an usage setting
Gets the environment's usage settings.
Gets the environment's usage settings.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_settings/usage-settings - Scope
billing:read - Effect
read— nothing is written. - Collection usage_settings
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the usage settings to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/usage_settings/default. |
uid | string | uset_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
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 | int32 | Days after an invoice's due time before the subject is past due. |
suspend_grace_days | int32 | 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. |
#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.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_settings/usage-settings" \
-H "Authorization: Bearer $SYLPHX_API_KEY"