← Tools Reference

RevenueCat

RevenueCat integration (Finance, Developer Tools, Subscriptions). Imported from open-connector.

API key12 toolshttps://api.revenuecat.com
GET
revenuecat_list_projects
List RevenueCat projects accessible to the configured secret API key.

/v2/projects

2 parameters
ParamTypeRequiredDescription
startingAfterstringoptionalReturn records after this RevenueCat cursor.
limitintegeroptionalMaximum number of records to return.
GET
revenuecat_list_customers
List customers in a RevenueCat project, optionally searching by email or customer identifier.

/v2/projects/{projectId}/customers

4 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
startingAfterstringoptionalReturn records after this RevenueCat cursor.
limitintegeroptionalMaximum number of records to return.
searchstringoptionalSearch by customer email, app user ID, store transaction identifier, or Apple o…
GET
revenuecat_get_customer
Retrieve a RevenueCat customer and optionally expand the customer's attributes.

/v2/projects/{projectId}/customers/{customerId}

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
customerIdstringrequiredRevenueCat customer or app user ID.
expandarrayoptionalOptional customer fields to expand in the response.
GET
revenuecat_list_customer_subscriptions
List subscriptions belonging to a RevenueCat customer.

/v2/projects/{projectId}/customers/{customerId}/subscriptions

4 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
customerIdstringrequiredRevenueCat customer or app user ID.
startingAfterstringoptionalReturn records after this RevenueCat cursor.
limitintegeroptionalMaximum number of records to return.
GET
revenuecat_get_subscription
Retrieve a RevenueCat subscription by its subscription ID.

/v2/projects/{projectId}/subscriptions/{subscriptionId}

2 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
subscriptionIdstringrequiredRevenueCat subscription ID.
GET
revenuecat_search_subscriptions
Find subscriptions by a store subscription identifier such as an Apple transaction ID or Google order ID.

/v2/projects/{projectId}/subscriptions

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
storeSubscriptionIdentifierstringrequiredStore subscription identifier to search for.
includeScheduledbooleanoptionalWhether to include subscriptions scheduled to start in the future.
GET
revenuecat_list_customer_active_entitlements
List the entitlements currently active for a RevenueCat customer.

/v2/projects/{projectId}/customers/{customerId}/active_entitlements

4 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
customerIdstringrequiredRevenueCat customer or app user ID.
startingAfterstringoptionalReturn records after this RevenueCat cursor.
limitintegeroptionalMaximum number of records to return.
GET
revenuecat_list_entitlements
List entitlement definitions configured in a RevenueCat project.

/v2/projects/{projectId}/entitlements

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
startingAfterstringoptionalReturn records after this RevenueCat cursor.
limitintegeroptionalMaximum number of records to return.
GET
revenuecat_list_offerings
List offerings configured in a RevenueCat project, optionally expanding packages and products.

/v2/projects/{projectId}/offerings

4 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
startingAfterstringoptionalReturn records after this RevenueCat cursor.
limitintegeroptionalMaximum number of records to return.
expandarrayoptionalOptional Offering fields to expand in the response.
GET
revenuecat_list_products
List products configured in a RevenueCat project.

/v2/projects/{projectId}/products

3 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
startingAfterstringoptionalReturn records after this RevenueCat cursor.
limitintegeroptionalMaximum number of records to return.
GET
revenuecat_get_overview_metrics
Retrieve overview metrics for a RevenueCat project.

/v2/projects/{projectId}/metrics/overview

2 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
currencystringoptionalCurrency used for the returned RevenueCat metrics.
GET
revenuecat_get_revenue_metric
Retrieve total RevenueCat project revenue for an inclusive date range.

/v2/projects/{projectId}/metrics/revenue

5 parameters
ParamTypeRequiredDescription
projectIdstringrequiredRevenueCat project ID.
startDatestringrequiredInclusive start date in ISO 8601 format.
endDatestringrequiredInclusive end date in ISO 8601 format.
currencystringoptionalCurrency used for the returned RevenueCat metrics.
revenueTypestringoptionalRevenue definition returned as the metric value.