Feature gating
Gate access to a feature based on the customer’s plan.
Kinde · Const
Entitlements
Entitlements are billing-plan capabilities that describe what a customer is allowed to use. Kinde SDK helpers can read all entitlements, retrieve one by key, or check billing-entitlement membership for a user.
How it works
Entitlements represents billing-plan capabilities available to a customer. SDK helpers read entitlement data from Kinde’s Account API so an application can retrieve all entitlements, inspect one by key, or test whether named plan entitlements are present.
Syntax
result, err := token.GetEntitlements(ctx, accountClient)
entitlement, err := token.GetEntitlement(ctx, accountClient, "seats")
ok, err := token.HasBillingEntitlements(ctx, accountClient, []string{"pro_plan"}, jwt.HasBillingEntitlementsOptions{})Key points
- An entitlement is a billing-plan-based capability that determines what a customer may use.
- The SDK entitlement helpers obtain their data from Kinde’s Account API.
- The Account API exposes entitlements so individual users can view the plan capabilities available to them.
- Plan features are the concrete functions or entitlements granted to users.
- Entitlements may represent metered, chargeable features or unmetered features included in a plan.
Common mistakes
- Do not use the Account API for organization plan-entitlement information; the documentation directs secure organization data access to the Management API.
- Treat an entitlement feature’s name, key, and type as immutable after creation; correct mistakes by replacing the feature.
Example: Check a billing entitlement
const entitlement = await getEntitlement('seats');
if (entitlement.isEntitled) {
enableSeatManagement();
}Read one billing entitlement and enable the related feature when the current user is entitled.
When to use it
Plan capability display
Show a user which capabilities their current plan provides.
Plan eligibility checks
Determine whether a user has one of the required billing plans.
Interview questions
QWhat is a Kinde entitlement?
Entitlements describe what a customer may use based on their billing plan. In the Go SDK, GetEntitlements reads the complete set from the Account API, while GetEntitlement retrieves one entitlement by key.
Follow-up: How would you check whether a customer has any of several plans? Use HasBillingEntitlements and pass the plan keys plus its options value.
QHow do you retrieve entitlements?
Use the SDK’s entitlement helper rather than parsing billing data manually. For example, the Go SDK exposes GetEntitlements(ctx, accountClient) and GetEntitlement(ctx, accountClient, "seats").
Follow-up: What data source do these helpers use? They read billing-entitlement data through the Kinde Account API using the user’s access token.
QWhat limitation applies to entitlement access?
Individual users can access their plan entitlements through the Account API. Organization plan-entitlement information is intentionally excluded because browser-accessible token data is less secure; use the Management API for secure data.
Follow-up: Why is the distinction significant? It prevents sensitive organization billing information from being exposed through a browser-scoped user token.
Related
GetEntitlementsGetEntitlementHasBillingEntitlementsAccount APIManagement APIbilling plansfeatures