Skip to main content
Skip to navigation
API docs by Redocly

Entitlements | REST API v1 Reference (1.0)

Download OpenAPI specification:Download

RevenueCat API v1 endpoint reference for Entitlements.

Entitlements

Part of the REST API v1 Reference.

Operations about entitlements.

Endpoints

Grant an Entitlement

Grants a Customer an entitlement. Does not override or defer a store transaction, applied simultaneously.

Note: Requests with an end_time_ms within 2 hours of an active promotional entitlement’s expiration are treated as duplicates and won't extend it. This is common in sandbox renewal testing.

Authorizations:
BearerAuth
path Parameters
app_user_id
required
string

The App User ID of the Customer.

entitlement_identifier
required
string

The identifier for the entitlement you want to grant to the Customer.

Request Body schema: application/json
end_time_ms
integer <int64>

A Unix epoch in milliseconds for when the entitlement should expire. The entitlement will always be granted immediately. If not provided then duration must be provided.

duration
string
Deprecated
Enum: "daily" "three_day" "weekly" "two_week" "monthly" "two_month" "three_month" "six_month" "yearly" "lifetime"

How long of a duration to grant the entitlement for. If not provided then end_time_ms must be provided.

start_time_ms
integer <int64>
Deprecated

A Unix epoch in milliseconds used to determine the expiration date, by adding duration to start_time_ms. Regardless of what start_time_ms is set to, the entitlement will always be granted immediately. If start_time_ms is not provided, the duration will be added to the current time to determine the expiration date.

Responses

Request samples

Content type
application/json
{
  • "start_time_ms": 1709195668093,
  • "end_time_ms": 1709196532093
}

Response samples

Content type
application/json
{
  • "value": {
    }
}

Revoke Granted Entitlements

Revokes all granted entitlements for a given entitlement identifier and App User ID.

Authorizations:
BearerAuth
path Parameters
app_user_id
required
string

The App User ID of the Customer.

entitlement_identifier
required
string

The identifier for the entitlement you want to revoke from the Customer.

Responses

Response samples

Content type
application/json
{
  • "value": {
    }
}

Endpoint Reference

All API v1 resources, one page each. General concepts (authentication, request format, URL parameters) live on the API v1 overview.