HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
Product Docs

Entitlements

Entitlements let you define and control which features or content a subscriber can access based on what they've purchased. Link entitlements to plans or items — when a customer subscribes, access is granted automatically. Changes to entitlements take effect immediately and are reflected in all subsequent API calls.
Not included in Starter or Pro — contact Recurly Sales to upgrade

Definition

Entitlements are granular access rights that define which features or services a subscriber can use. They are linked to recurring products — plans or items — and are granted automatically when a customer purchases a subscription. Entitlements can be applied across platforms (web, mobile, and app stores) and checked in real time via the Recurly API.

Key benefits

Controlled access Define exactly which features each subscriber tier can access, creating differentiated experiences across your product.
Cross-platform consistency Configure and apply entitlements across web, mobile, and app stores from a single interface.
Enhanced monetization Gate premium features or content behind paywalls to drive revenue from tiered subscription offerings.
Unlimited flexibility Create as many entitlements as your product needs, each linkable to multiple plans or items.

Key details

Entitlement attributes

Each entitlement is defined by four attributes:

AttributeDescription
NameA concise label summarizing the entitlement's function. Does not appear on subscriber invoices, Checkout, or Hosted Payment Pages. 255-character limit.
CodeA unique identifier within Recurly used to link the entitlement to specific features or functionality in your application, such as feature flags.
DescriptionA detailed explanation of what the entitlement provides — useful for internal reference and customer-facing context.
GrantorsThe recurring products (plans or items) that grant the entitlement upon subscription purchase. An entitlement can be linked to multiple products, and a single product can correspond to multiple entitlements.

Create an entitlement

1

Navigate to Entitlements

Log in to the Recurly Admin UI and go to the Entitlements section.

2

Start a new entitlement

Click Create your first entitlement.

3

Define the attributes

Enter the Name, Code, Description, and Grantors for the entitlement. See the attribute reference table above for field details.

4

Save

Click Create Entitlement to save. The entitlement is available immediately.

Assign an entitlement to a plan or item

Entitlements can be assigned to plans or items during creation or by editing an existing entitlement.

1

Open the entitlement

Navigate to the Entitlements section and select the entitlement you want to assign.

2

Click Edit Entitlement

3

Add an assignment

Click Add Assignment and choose Plan or Item.

4

Select from the list

Choose the plan or item to link to this entitlement.

5

Save changes

Update an entitlement

1

Open the entitlement

Navigate to the Entitlements section and select the entitlement to update.

2

Make changes

Update any attributes or grantor assignments as needed.

3

Save

Changes take effect immediately and are reflected in all subsequent API calls.

Delete an entitlement

Deletion is immediate and permanent Deleting an entitlement removes it from the system instantly. Ensure no active subscriptions or features depend on the entitlement before proceeding.
1

Open the entitlement

Navigate to the Entitlements section and select the entitlement to delete.

2

Delete and confirm

Click Delete, then Confirm. The entitlement is removed immediately.