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
Update an usage tier
Creates or updates a usage tier.
Creates or updates a usage tier.
- Path
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_tiers/usage-tier - Scope
billing:write - Effect
write— a successful call changes state. - Collection usage_tiers
- Query
update_mask
#Request
| Field | Type | What it is |
|---|---|---|
usage_tier | UsageTier | The usage tier with its new values; name selects it. Required. |
update_mask | field_mask | The fields to change. |
#UsageTier
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/usage_tiers/{usage_tier}; the id is the tier key. |
meta | ResourceMeta | Resource metadata. |
rank | int32 | Order of tiers; 0 is the base tier. Required. |
daily_limit_minor | string | Daily exposure limit in minor units, a decimal string; empty for none. |
monthly_limit_minor | string | Monthly exposure limit in minor units, a decimal string; empty for none. |
threshold_minor | string | The amount an invoice would make due at which a threshold invoice is cut. Required. |
requires_paid_invoices | int32 | Paid invoices needed to reach this tier. |
requires_paid_minor | string | Paid total, minor units, needed to reach this tier. |
#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_tiers/{usage_tier}; the id is the tier key. |
uid | string | utier_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
rank | int32 | Order of tiers; 0 is the base tier. Required. |
daily_limit_minor | string | Daily exposure limit in minor units, a decimal string; empty for none. |
monthly_limit_minor | string | Monthly exposure limit in minor units, a decimal string; empty for none. |
threshold_minor | string | The amount an invoice would make due at which a threshold invoice is cut. Required. |
requires_paid_invoices | int32 | Paid invoices needed to reach this tier. |
requires_paid_minor | string | Paid total, minor units, needed to reach this tier. |
#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_tiers/usage-tier" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"orgs/acme/projects/shop/envs/production/usage_tiers/usage-tier","rank":1,"threshold_minor":"…"}'