Skip to content
Console
Menu

Generated Assets

Workflows

Getting Started

Authentication

KV Store

List usage tiers

Lists usage tiers.

Lists usage tiers.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_tiers
  • Scope billing:read
  • Effect read — nothing is written.
  • Collection usage_tiers
  • Query page_size, page_token, filter
  • Pagination the answer carries usage_tiers and, when there is more, next_page_token

#Request

FieldTypeWhat it is
parentstringThe parent to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter, for example subject = "…".

#Response

FieldTypeWhat it is
usage_tiersUsageTier[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

#UsageTier

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/usage_tiers/{usage_tier}; the id is the tier key.
uidstringutier_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
rankint32Order of tiers; 0 is the base tier. Required.
daily_limit_minorstringDaily exposure limit in minor units, a decimal string; empty for none.
monthly_limit_minorstringMonthly exposure limit in minor units, a decimal string; empty for none.
threshold_minorstringThe amount an invoice would make due at which a threshold invoice is cut. Required.
requires_paid_invoicesint32Paid invoices needed to reach this tier.
requires_paid_minorstringPaid total, minor units, needed to reach this tier.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/usage_tiers" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"