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
List entitlements
Lists an org's entitlements: exactly one, `default`.
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.
Lists an org's entitlements: exactly one, default.
Not available yet. Sylphx Entitlement 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/entitlements - Scope
entitlement:read - Effect
read— nothing is written. - Collection entitlements
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
entitlementsand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The org to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
filter | string | AIP-160 filter over labels, filterable spec fields, and Ready. |
order_by | string | AIP-132 ordering over filterable fields. |
#Response
| Field | Type | What it is |
|---|---|---|
entitlements | Entitlement[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#Entitlement
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/entitlements/default. |
uid | string | ent_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. Output only. |
spec | EntitlementSpec | Billing's latest decision. Output only. |
status | EntitlementStatus | Observed state. 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. |
#EntitlementSpec
| Field | Type | What it is |
|---|---|---|
plan | string | The plan, for example plans/pro. Output only. |
plan_version | string | The plan version, for example pro@2026-11-02. Output only. |
state | AccountState | The account state derived from plan and payment. Output only. One of active, past_due, suspended, unclaimed. |
platforms | bool | Sylphx for Platforms is enabled (partner sub-orgs). Output only. |
meters | MeterAllowance[] | Included usage and over-limit behaviour per meter. Output only. |
resource_limits | ResourceLimit[] | Limits on how many Resources of a collection the org may hold. Output only. |
rate_limits | RateLimit[] | Request rate limits per rate class. Output only. |
lease_pools | LeasePolicy[] | Budget-lease policy per hard-spend pool. Output only. |
compute_time | timestamp | When Billing computed this decision. The platform enforces it as is for 24 hours after this time; past that, non-hard-spend checks fail open. Output only. |
decision_sequence | int64 | Monotonic per org; the platform never applies a lower sequence than it holds. Output only. |
overrides | PartnerOverride[] | Caps a partner set on this sub-org, each at most the partner's own. Output only. |
#EntitlementStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
published_generation | int64 | The Snapshot generation that first carried this decision. Output only. |
#MeterAllowance
| Field | Type | What it is |
|---|---|---|
meter | string | The meter id, for example hosting.vcpu_seconds. Output only. |
included | int64 | Included quantity per billing period, in the meter's base unit. Output only. |
overage | Overage | What happens past the included quantity. Output only. One of deny, bill, bill_until_spend_limit. |
exhausted | bool | The included quantity is used up, as of compute_time. Output only. |
price_version_override | string | An org-specific price version (enterprise, partner); empty for list price. Output only. |
#ResourceLimit
| Field | Type | What it is |
|---|---|---|
collection | string | The collection, for example projects. Output only. |
limit | int64 | The most Resources allowed; zero means none, -1 means unlimited. Output only. |
#RateLimit
| Field | Type | What it is |
|---|---|---|
rate_class | string | control or inference. Output only. |
requests_per_minute | int64 | Requests per minute, per org, enforced per cell. Output only. |
requests_per_second | int64 | Sustained requests per second of the org's token bucket (the plan's class, raised by its committed-spend band). Output only. |
burst | int64 | Requests the bucket holds for a burst. Output only. |
#LeasePolicy
| Field | Type | What it is |
|---|---|---|
pool | string | The pool: sandboxes, ai, runners, or notify.sms. Output only. |
max_lease_nano_usd | int64 | The largest lease Billing grants, in nano-USD. Output only. |
offline_allowance_nano_usd | int64 | What a holder may spend when it holds no lease and Billing is unreachable, in nano-USD. Output only. |
lease_required | bool | Spend in this pool requires a lease. Output only. |
#PartnerOverride
| Field | Type | What it is |
|---|---|---|
meter | string | The meter id. Output only. |
cap | int64 | The cap, in the meter's base unit per billing period. Output only. |
partner_org | string | The partner org that set the cap. Output only. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/entitlements" \
-H "Authorization: Bearer $SYLPHX_API_KEY"