Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Budget leases

A BudgetLease is budget Billing pre-authorized for one holder to spend on hard-spend usage without calling Billing per request.

This method is not served on the public API. api.sylphx.com does 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.

A BudgetLease is budget Billing pre-authorized for one holder to spend on hard-spend usage without calling Billing per request. Readable by the org; written only by Billing.

Service Sylphx Billing · Resource type billing.sylphx.com/BudgetLease · Name pattern orgs/{org}/budget_leases/{budget_lease} · Shape record

Not available yet. Sylphx Billing is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

#Fields

FieldTypeWhat it is
namestringorgs/{org}/budget_leases/{budget_lease}.
uidstringbl_<cell><ulid>. Output only.
metaResourceMetaResource metadata. Output only.
holderstringThe holder: a SPIFFE role and cell, for example services/sandboxes/cells/fs01. Output only.
poolstringThe pool: sandboxes, ai, runners, or notify.sms. Output only.
granted_nano_usdint64Billing's valuation of the grant at list price, in nano-USD; 0 for a class Sylphx runs but does not sell. Output only.
fenceint64The fence: monotonic per org, holder, and lease key; a renewal carrying an older value is refused. Output only.
expire_timetimestampWhen the holder stops debiting the lease. Output only.
stateBudgetLeaseStateThe lease's lifecycle state. Output only. One of active, released, expired, settled, refused.
reported_debit_nano_usdint64The debit the holder reported on renew or release, in nano-USD. Output only.
settled_debit_nano_usdint64The debit rated from ingested usage, in nano-USD. Output only.
meterstringThe 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_versionint32The meter version leased. Output only.
dimensionsmap<string, string>The lease key: the meter's required dimensions. Output only.
granted_quantityint64The units granted, in the meter's base unit. Output only.
reported_debit_quantityint64The units the holder reported on renew or release. Output only.
settled_quantityint64The units ingested usage attributes to the lease. Output only.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a budget lease.
GETlistLists an org's budget leases.

#get

Gets a budget lease.

GET https://api.sylphx.com/v1/orgs/acme/budget_leases/budget-lease · scope billing:read · effect read · not available yet · Request, response and examples

#list

Lists an org's budget leases.

GET https://api.sylphx.com/v1/orgs/acme/budget_leases · scope billing:read · effect read · not available yet · paginated · Request, response and examples