Entitlement grants
An Entitlement Grant is one feature a subject holds, from one source: a subscription, an order, a store purchase, or a manual grant.
An Entitlement Grant is one feature a subject holds, from one source: a subscription, an order, a store purchase, or a manual grant. Money derives it; a client event never writes one.
Service Sylphx Money · Resource type money.sylphx.com/EntitlementGrant · Name pattern orgs/{org}/projects/{project}/envs/{env}/entitlement_grants/{entitlement_grant} · Shape record
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/entitlement_grants/{entitlement_grant}. |
uid | string | egr_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
subject | Subject | Who holds it. |
feature | string | The feature key. |
limit | string | For a limit feature, the allowance as a decimal string. Output only. |
source | string | The resource that grants it, for example a customer subscription's name. Output only. |
expire_time | timestamp | When it ends; unset for no end. |
campaign | string | A manual grant's campaign (input on create, up to 64 characters). |
reason | string | A manual grant's reason (input on create, up to 500 characters). |
approval_ref | string | A free-text reference to the approval, for example CEO 2026-10-02 (input on create, up to 200 characters). A test grant's (test/<id>) is set by the server, synthetic:<env>:<synthetic_time>, and the input is ignored. |
approver | string | The principal that created a manual grant: the verified key's principal, never a request field. 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 entitlement grant. |
GET | list | Lists entitlement grants. Continuation tokens reject collection changes with ETAG_MISMATCH; restart without a page token after a conflict. |
GET | snapshot | Reads a coherent entitlement snapshot with an environment-wide source revision. Discard every page and restart after ETAG_MISMATCH. |
POST | check | Answers whether a subject holds a feature now, and how much of it. |
POST | create | Creates a manual entitlement grant (support, comp, grace). Append-only. The subject decides what it needs: an end user the env's Sylphx Auth stamped as a born-synthetic test account gets a test grant (test/<id>, at most 90 days, approval_ref set by the server) with billing:test_grants:write; any other subject needs the approval-class billing:credits.approve and is refused PERMISSION_DENIED (subject_not_synthetic) otherwise. The approver recorded is the key's principal. |
get
Gets an entitlement grant.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants/entitlement-grant · scope billing:read · effect read · Request, response and examples
list
Lists entitlement grants. Continuation tokens reject collection changes with ETAG_MISMATCH; restart without a page token after a conflict.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants · scope billing:read · effect read · paginated · Request, response and examples
snapshot
Reads a coherent entitlement snapshot with an environment-wide source revision. Discard every page and restart after ETAG_MISMATCH.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants:snapshot · scope billing:read · effect read · Request, response and examples
check
Answers whether a subject holds a feature now, and how much of it.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants:check · scope billing:read · effect read · Request, response and examples
create
Creates a manual entitlement grant (support, comp, grace). Append-only. The subject decides what it needs: an end user the env's Sylphx Auth stamped as a born-synthetic test account gets a test grant (test/<id>, at most 90 days, approval_ref set by the server) with billing:test_grants:write; any other subject needs the approval-class billing:credits.approve and is refused PERMISSION_DENIED (subject_not_synthetic) otherwise. The approver recorded is the key's principal.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants · scope billing:test_grants:write · effect write · Request, response and examples