Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RevenueCat Entitlements (v1) API

v1 promotional entitlement grant and revoke.

RevenueCat Entitlements (v1) API is one of 12 APIs that RevenueCat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entitlements (v1). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://api.revenuecat.com/v1, https://api.revenuecat.com/v2.

2 operations 2 paths 3 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.revenuecat.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

RevenueCat Entitlements (v1) API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — RevenueCat API key passed as an HTTP Bearer token. v1 accepts public (client) or secret (server) keys; v2 uses dedicated v2 API keys.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Entitlements (v1) 2

v1 promotional entitlement grant and revoke.

POST
/subscribers/{app_user_id}/entitlements/{entitlement_identifier}/promotional
Grant a promotional entitlement
grantPromotionalEntitlement 2 params body → 200
POST
/subscribers/{app_user_id}/entitlements/{entitlement_identifier}/revoke_promotionals
Revoke promotional entitlements
revokePromotionalEntitlements 2 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Subscriber (8 properties), SubscriberResponse (3 properties), EntitlementInfo (3 properties). Each schema is shown below with its type and property counts.

Subscriber
object
8 properties
EntitlementInfo
object
3 properties
SubscriberResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

revenuecat-entitlements-v1-api-openapi.yml Raw ↑

Other APIs RevenueCat publishes across the network.

RevenueCat Webhooks
RevenueCat Apps API
RevenueCat Customers API
RevenueCat Entitlements (v2) API
RevenueCat Offerings (v1) API
RevenueCat Offerings (v2) API
RevenueCat Packages API
RevenueCat Products API
RevenueCat Projects API
RevenueCat Purchases API
RevenueCat Subscribers API