Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

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

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/entitlement_grants/{entitlement_grant}.
uidstringegr_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
subjectSubjectWho holds it. Output only.
featurestringThe feature key. Output only.
limitstringFor a limit feature, the allowance as a decimal string. Output only.
sourcestringThe resource that grants it, for example a customer subscription's name. Output only.
expire_timetimestampWhen it ends; unset for no end. 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.

MethodCallWhat it does
GETgetGets an entitlement grant.
GETlistLists entitlement grants.
POSTcheckAnswers whether a subject holds a feature now, and how much of it.

#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.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/entitlement_grants · scope billing:read · effect read · paginated · 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