Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
Get a budget lease
Gets a budget lease.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Gets a budget lease.
Not available yet. Sylphx Billing is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/orgs/acme/budget_leases/budget-lease - Scope
billing:read - Effect
read— nothing is written. - Collection budget_leases
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the budget lease to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/budget_leases/{budget_lease}. |
uid | string | bl_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. Output only. |
holder | string | The holder: a SPIFFE role and cell, for example services/sandboxes/cells/fs01. Output only. |
pool | string | The pool: sandboxes, ai, runners, or notify.sms. Output only. |
granted_nano_usd | int64 | Billing's valuation of the grant at list price, in nano-USD; 0 for a class Sylphx runs but does not sell. Output only. |
fence | int64 | The fence: monotonic per org, holder, and lease key; a renewal carrying an older value is refused. Output only. |
expire_time | timestamp | When the holder stops debiting the lease. Output only. |
state | BudgetLeaseState | The lease's lifecycle state. Output only. One of active, released, expired, settled, refused. |
reported_debit_nano_usd | int64 | The debit the holder reported on renew or release, in nano-USD. Output only. |
settled_debit_nano_usd | int64 | The debit rated from ingested usage, in nano-USD. Output only. |
meter | string | The leased meter. A lease is in the meter's units: the holder never holds a price, Billing prices each grant from its price book. Output only. |
meter_version | int32 | The meter version leased. Output only. |
dimensions | map<string, string> | The lease key: the meter's required dimensions. Output only. |
granted_quantity | int64 | The units granted, in the meter's base unit. Output only. |
reported_debit_quantity | int64 | The units the holder reported on renew or release. Output only. |
settled_quantity | int64 | The units ingested usage attributes to the lease. Output only. |
#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/budget_leases/budget-lease" \
-H "Authorization: Bearer $SYLPHX_API_KEY"