sylphx money entitlement_grants
Every sylphx money entitlement_grants command: its argument, its flags and a run line.
The entitlement_grants commands of Sylphx Money, as the CLI spells them: the same
calls as the entitlement_grants API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
get
Gets an entitlement grant.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money entitlement-grants get orgs/acme/projects/shop/envs/production/entitlement_grants/entitlement-grantGET 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.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx money entitlement-grants list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants · scope billing:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | 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 filterable fields, for example feature = "plus". |
snapshot
Reads a coherent entitlement snapshot with an environment-wide source revision. Discard every page and restart after ETAG_MISMATCH.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money entitlement-grants snapshot orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants:snapshot · scope billing:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page of this snapshot. |
--filter | string | AIP-160 filter over entitlement grant fields. |
--snapshot-revision | string | Expected environment-wide collection revision, as a canonical decimal string. Empty selects the current source snapshot; any nonempty value, including "0", requires equality or returns HTTP 409 ETAG_MISMATCH. Send the first response's revision on every subsequent page. Page tokens also fence that revision and cannot be reused after a collection change. |
check
Answers whether a subject holds a feature now, and how much of it.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money entitlement-grants check orgs/acme/projects/shop/envs/productionPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants:check · scope billing:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--subject | json | Who. Required. |
--feature | string | The feature key. Required. |
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.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx money entitlement-grants create --parent orgs/acme/projects/shop/envs/productionPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants · scope billing:test_grants:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--subject.end-user | string | An end user's id (Sylphx Auth, or the app's own OIDC issuer). |
--subject.customer-organization | string | A customer organization's id. |
--feature | string | The feature key. |
--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. |