canonical: https://jentic.com/apis/revenuecat.com/revenuecat

# Revenuecat Developer API

The RevenueCat Developer API (v2) reads and manages in-app subscription data for mobile and web apps across a RevenueCat project. It looks up customers with their active entitlements, subscriptions, purchases, aliases, attributes, invoices, and virtual currency balances, and it configures the monetisation model: products, entitlements, offerings, packages, and paywalls. It can also cancel or refund Web Billing subscriptions and purchases, refund Play Store subscription transactions, transfer purchases between customers, and return overview metrics for the project.

## For AI agents

Check a customer's active entitlements and subscriptions, configure products, entitlements, offerings, and packages, refund or cancel Web Billing purchases, and read project overview metrics in RevenueCat.

## Scope

Does not handle processing card payments directly, App Store refunds, push notifications, or app analytics beyond overview metrics. Use for RevenueCat customers, subscriptions, entitlements, offerings, and Web Billing actions only.

## Capabilities

- Check which entitlements a customer currently has with list-customer-active-entitlements
- Find a subscription from an App Store transaction ID or Play Store order ID with search-subscriptions and store_subscription_identifier
- Cancel or refund an active Web Billing subscription, refund a Web Billing purchase, or refund a Play Store subscription transaction
- Move a customer's subscriptions and one-time purchases to another customer with transfer-customer-data and target_customer_id
- Create an entitlement by lookup_key and display_name, then attach products to it with attach-products-to-entitlement
- Build offerings and packages and create a paywall for an offering_id
- Read overview metrics for a project with get-overview-metrics, optionally in a chosen currency

## Use cases

### Agent-led subscription support through Jentic

A support agent connected through Jentic searches by intent for checking a customer's subscription, gets the RevenueCat operations with their schemas, and reads the customer's active entitlements and subscriptions for the project. If the customer paid through Web Billing and qualifies for a refund, the agent calls refund-subscription, so the support reply is backed by what RevenueCat actually shows.

Example prompt: GET `/projects/proj1ab2c3d4/customers/user_123/active_entitlements`, then GET `/projects/proj1ab2c3d4/customers/user_123/subscriptions` and report status and entitlement ids

### Store receipt to customer lookup

When a user forwards an App Store receipt or Google Play order ID, an agent calls search-subscriptions with the store_subscription_identifier, which matches any App Store transaction ID or Play Store order ID from past or current periods, to find the RevenueCat subscription. From there it lists the subscription's entitlements and, for Play Store subscriptions, its transactions.

Example prompt: GET `/projects/proj1ab2c3d4/subscriptions` with store_subscription_identifier '2000000123456789', then GET `/projects/proj1ab2c3d4/subscriptions/{subscription_id}/entitlements`

### Monetisation model setup

A developer setting up a new app has an agent create an entitlement with lookup_key 'pro' and a display_name, create products, attach them to the entitlement, then build an offering with packages and create a paywall for it. The whole product, entitlement, offering, and package structure is set from code instead of clicking through the dashboard.

Example prompt: POST `/projects/proj1ab2c3d4/entitlements` with lookup_key 'pro' and display_name 'Pro', then POST `/projects/proj1ab2c3d4/entitlements/{entitlement_id}/actions/attach_products` with the monthly and annual product ids

### Account merge and virtual currency adjustments

When a user signs in on a new account, an agent moves their subscriptions and one-time purchases with transfer-customer-data to the target_customer_id, optionally limited to app_ids. For games or credit-based apps, it can grant or deduct virtual currency with create-virtual-currencies-transaction, passing adjustments and an Idempotency-Key so a retry does not double-credit.

Example prompt: POST `/projects/proj1ab2c3d4/customers/old_user_1/actions/transfer` with target_customer_id 'new_user_9'

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/projects/{project_id}/customers/{customer_id}/active_entitlements` | List a customer's active entitlements |
| GET | `/projects/{project_id}/customers/{customer_id}/subscriptions` | List a customer's subscriptions |
| GET | `/projects/{project_id}/subscriptions` | Search subscriptions by store identifier |
| POST | `/projects/{project_id}/subscriptions/{subscription_id}/actions/refund` | Refund a Web Billing subscription |
| POST | `/projects/{project_id}/customers/{customer_id}/actions/transfer` | Transfer purchases to another customer |
| POST | `/projects/{project_id}/entitlements` | Create an entitlement |
| POST | `/projects/{project_id}/offerings` | Create an offering |
| GET | `/projects/{project_id}/metrics/overview` | Get overview metrics |

## Key resources

- **Customers** — App users with active entitlements, aliases, attributes, invoices, and virtual currency balances
- **Subscriptions** — Store or Web Billing subscriptions with entitlements, transactions, cancel, and refund actions
- **Purchases** — One-time purchases with entitlements and Web Billing refunds
- **Entitlements** — Access levels such as pro, keyed by lookup_key, with attached products
- **Offerings and packages** — Groupings of products shown to users, plus paywalls
- **Products** — Store products that can be pushed to the store and attached to entitlements

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 54 / 100
  - Developer Experience & Jentic Compatibility: 78 / 100
  - AI-Readiness & Agent Experience: 55 / 100
  - Agent Usability: 92 / 100
  - Security: 60 / 100
  - AI Discoverability: 66 / 100
- **View full report:** https://jentic.com/apis/revenuecat.com/revenuecat/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring RevenueCat by hand means using a bearer API key with the right per-domain permissions, threading project_id through every path, and handling per-domain rate limit headers and 429 back-off. Through Jentic you install once, import the RevenueCat Developer API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** RevenueCat puts the project id, and below it the customer id, in the URL path (`/projects/{project_id}/customers/{customer_id}/...`), so a rule can pin your agent to one project or a set of customer reads. You choose the operations it may call, so destructive ones like refund-subscription, delete-customer, or transfer-customer-data are not included unless you add them.
- **Credential handling:** Your RevenueCat API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'check a customer's active entitlements' or 'refund a Web Billing purchase', and Jentic returns the matching RevenueCat operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Adapty API** — In-app subscription infrastructure with paywalls and analytics
- **Stripe API** — Web payments and subscription billing
- **Google Play Android Developer API** — Google Play purchases, subscriptions, and app listings
- **App Store Connect API** — Apple app, in-app purchase, and sales report management

## FAQ

### What authentication does the RevenueCat Developer API use?

Per its OpenAPI spec, the API takes a RevenueCat API key as a bearer token in the Authorization header. Each operation lists the permission it needs, such as customer_information:subscriptions:read_write or project_configuration:entitlements:read_write, so the key must carry those permissions. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time.

### What are the rate limits for the RevenueCat Developer API?

The spec describes rate limiting per domain, such as customer_information or charts_metrics, over a one-minute period. Successful responses carry RevenueCat-Rate-Limit-Current-Usage and RevenueCat-Rate-Limit-Current-Limit headers, and a 429 response includes Retry-After and a backoff_ms field. See https://www.revenuecat.com/docs for the current limit values.

### Can I refund a subscription with the RevenueCat Developer API?

Yes, for supported stores. The spec has refund actions for active Web Billing subscriptions, Web Billing purchases, and individual Play Store subscription transactions, and a cancel action for Web Billing subscriptions, which ends access at the end of the current period.

### Is there a RevenueCat MCP server?

You don't need an MCP server to give your agent the RevenueCat Developer API. Jentic connects it directly from the API Directory: import it, store your API key once, and your agent calls it. Operations are found by intent when needed, so no extra tool definitions sit in your agent's context.

### How do I check a customer's entitlements through Jentic?

Install Jentic One, add the RevenueCat Developer API from the directory, and store a key with customer read permissions. Your agent searches for 'check a customer's active entitlements', gets the active_entitlements operation under `/projects/{project_id}/customers/{customer_id}`, and calls it with your project and customer ids. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the RevenueCat Developer API?

Yes. Write a rule that allows only GET requests under `/projects/proj1ab2c3d4/customers`/, so the agent can read customers, entitlements, and subscriptions in that one project but cannot refund, cancel, transfer purchases, or change products, and every call it makes is logged.
