Console

Start

Platform

App store purchases

Auth

Builds

Credits

Credit grants

Database

Flags

Generated Assets

Assets

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
UsageSettings
ResourceMeta
Response
ResourceMeta
Errors
Examples

Reference

Update an usage setting

Updates the usage settings, the enforcement switch included.

Checked 2026-09-28

Updates the usage settings, the enforcement switch included. A change is recorded with who made it.

Path PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_settings/usage-settings
Scope billing:write
Effect write — a successful call changes state.
Collection usage_settings
Query update_mask

#Request

Field	Type	What it is
`usage_settings`	`UsageSettings`	The usage settings with its new values; `name` selects it. Required.
`update_mask`	`field_mask`	The fields to change.

#UsageSettings

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/usage_settings/default`.
`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
`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.

#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.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
ETAG_MISMATCH — The etag sent does not match the Resource's current etag.
IDEMPOTENCY_KEY_REUSED — An Idempotency-Key was reused with another body.
IDEMPOTENCY_IN_PROGRESS — The first call with this Idempotency-Key is still running.

Every error arrives in the body Errors describes.

#Examples

curl -X PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_settings/usage-settings" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"currency_code":"…","name":"orgs/acme/projects/shop/envs/production/usage_settings/usage-settings"}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links