RevenueCat
Query RevenueCat metrics and search documentation.
Config
Set RC_API_KEY environment variable, which should be a v2 secret API key.
Context
Query the RevenueCat API (GET /projects) to get information about the project you have access to. Your RevenueCat API key allows access to a single project. Use the project ID in subsequent API calls.
API Access
{baseDir}/scripts/rc-api.sh <endpoint>
Example: {baseDir}/scripts/rc-api.sh /projects to list projects.
Local API Reference
Start with {baseDir}/references/api-v2.md for auth, pagination, and common patterns. Then load the domain file you need:
| Domain |
File |
Covers |
| Customers |
references/customers.md |
CRUD, attributes, aliases, entitlements, subscriptions, purchases, invoices, virtual currencies, actions |
| Subscriptions |
references/subscriptions.md |
List, get, transactions, cancel, refund, management URL |
| Products |
references/products.md |
CRUD, create in store, test prices |
| Offerings |
references/offerings.md |
Offerings, packages, package products |
| Entitlements |
references/entitlements.md |
CRUD, attach/detach products |
| Purchases |
references/purchases.md |
List, get, refund, entitlements |
| Projects |
references/projects.md |
Projects, apps, API keys, StoreKit config |
| Metrics |
references/metrics.md |
Overview metrics, charts, chart options |
| Paywalls |
references/paywalls.md |
Paywall creation |
| Integrations |
references/integrations.md |
Integrations CRUD |
| Virtual Currencies |
references/virtual-currencies.md |
Virtual currencies CRUD |
| Error Handling |
references/error-handling.md |
Error handling |
| Rate Limits |
references/rate-limits.md |
Rate limits |
Only load the reference file relevant to the current task — don't load them all.
Remote Documentation Search
The RevenueCat documentation is available at https://www.revenuecat.com/docs. Use https://www.revenuecat.com/docs/llms.txt and /sitemap.xml as a guide to the content that is available. Add .md to the end of a documentation URL to get the markdown version of the page.
1---2name: revenuecat3description: RevenueCat metrics, customer data, and documentation search. Use when querying subscription analytics, MRR, churn, customers, or RevenueCat docs.4license: MIT5---6
7# RevenueCat
8
9Query RevenueCat metrics and search documentation.
10
11## Config
12
13Set `RC_API_KEY` environment variable, which should be a v2 secret API key.
14
15## Context
16
17Query the RevenueCat API (`GET /projects`) to get information about the project you have access to. Your RevenueCat API key allows access to a single project. Use the project ID in subsequent API calls.
18
19## API Access
20
21```bash
22{baseDir}/scripts/rc-api.sh <endpoint>
23```
24
25Example: `{baseDir}/scripts/rc-api.sh /projects` to list projects.
26
27## Local API Reference
28
29Start with `{baseDir}/references/api-v2.md` for auth, pagination, and common patterns. Then load the domain file you need:
30
31| Domain | File | Covers |
32| ------------------ | ---------------------------------- | -------------------------------------------------------------------------------------------------------- |
33| Customers | `references/customers.md` | CRUD, attributes, aliases, entitlements, subscriptions, purchases, invoices, virtual currencies, actions |
34| Subscriptions | `references/subscriptions.md` | List, get, transactions, cancel, refund, management URL |
35| Products | `references/products.md` | CRUD, create in store, test prices |
36| Offerings | `references/offerings.md` | Offerings, packages, package products |
37| Entitlements | `references/entitlements.md` | CRUD, attach/detach products |
38| Purchases | `references/purchases.md` | List, get, refund, entitlements |
39| Projects | `references/projects.md` | Projects, apps, API keys, StoreKit config |
40| Metrics | `references/metrics.md` | Overview metrics, charts, chart options |
41| Paywalls | `references/paywalls.md` | Paywall creation |
42| Integrations | `references/integrations.md` | Integrations CRUD |
43| Virtual Currencies | `references/virtual-currencies.md` | Virtual currencies CRUD |
44| Error Handling | `references/error-handling.md` | Error handling |
45| Rate Limits | `references/rate-limits.md` | Rate limits |
46
47Only load the reference file relevant to the current task — don't load them all.
48
49## Remote Documentation Search
50
51The RevenueCat documentation is available at https://www.revenuecat.com/docs. Use https://www.revenuecat.com/docs/llms.txt and /sitemap.xml as a guide to the content that is available. Add .md to the end of a documentation URL to get the markdown version of the page.
modbender