---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Budget leases"
description: "The `budget_leases` collection of Sylphx Billing: A BudgetLease is budget Billing pre-authorized for one holder to spend on hard-spend usage without calling Billing per request."
type: reference
product: platform
summary: "A BudgetLease is budget Billing pre-authorized for one holder to spend on hard-spend usage without calling Billing per request."
updated: 2026-09-28
order: 900
---

> **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

| 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. |

## 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.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/budget_leases#get) | Gets a budget lease. |
| `GET` | [`list`](/docs/api/budget_leases#list) | Lists 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](/docs/api/budget_leases/get)

## 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](/docs/api/budget_leases/list)