Reference

Entitlements

An Entitlement is what an org may use: its plan, account state, included usage per meter, resource and rate limits, and budget-lease policy.

Checked 2026-09-28

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.

An Entitlement is what an org may use: its plan, account state, included usage per meter, resource and rate limits, and budget-lease policy. Each org has exactly one, orgs/{org}/entitlements/default; its spec is Billing's latest decision and its history is Billing's decision log.

Service Sylphx Entitlement · Resource type entitlement.sylphx.com/Entitlement · Name pattern orgs/{org}/entitlements/{entitlement} · Shape spec_status

Not available yet. Sylphx Entitlement 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}/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.

#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	Gets an org's entitlement.
GET	list	Lists an org's entitlements: exactly one, default.

#get

Gets an org's entitlement.

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

#list

Lists an org's entitlements: exactly one, default.

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