Skip to content
Console
Menu

Getting Started

Authentication

KV Store

On this page

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

Shell
sylphx money entitlement-grants get orgs/acme/projects/shop/envs/production/entitlement_grants/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.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx money entitlement-grants list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants · scope billing:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over filterable fields, for example feature = "plus".

#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

Shell
sylphx money entitlement-grants check orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants:check · scope billing:read · effect read · Request, response and examples

Flags

FlagTypeWhat it does
--subjectjsonWho. Required.
--featurestringThe feature key. Required.

#create

Creates a manual entitlement grant (support, comp, grace). Append-only; needs the approval-class scope. 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

Shell
sylphx money entitlement-grants create --parent orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants · scope billing:credits.approve · effect write · Request, response and examples

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--subject.end-userstringAn end user's id (Sylphx Auth, or the app's own OIDC issuer).
--subject.customer-organizationstringA customer organization's id.
--featurestringThe feature key.
--expire-timetimestampWhen it ends; unset for no end.
--campaignstringA manual grant's campaign (input on create, up to 64 characters).
--reasonstringA manual grant's reason (input on create, up to 500 characters).
--approval-refstringA free-text reference to the approval, for example CEO 2026-10-02 (input on create, up to 200 characters).