Integrate RevenueCat into the workflow. Manage subscribers, entitlements, offerings, and Google Play subscriptions. Retrieve customer subscription status, grant or revoke promotional entitlements, record purchases, update subscriber attributes, and manage Google Play subscription billing.
Retrieve subscriber information by app user ID
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat secret API key (sk_...) |
appUserId | string | Yes | The app user ID of the subscriber |
| Parameter | Type | Description |
|---|
subscriber | object | The subscriber object with subscriptions and entitlements |
metadata | object | Subscriber summary metadata |
Permanently delete a subscriber and all associated data
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat secret API key (sk_...) |
appUserId | string | Yes | The app user ID of the subscriber to delete |
| Parameter | Type | Description |
|---|
deleted | boolean | Whether the subscriber was deleted |
app_user_id | string | The deleted app user ID |
Record a purchase (receipt) for a subscriber via the REST API
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat API key (public or secret) |
appUserId | string | Yes | The app user ID of the subscriber |
fetchToken | string | Yes | For iOS, the base64-encoded receipt (or JWSTransaction for StoreKit2); for Android the purchase token; for Amazon the receipt; for Stripe the subscription ID or Checkout Session ID; for Roku the transaction ID; for Paddle the subscription ID or transaction ID |
productId | string | No | Apple, Google, Amazon, Roku, or Paddle product identifier or SKU. Required for Google. |
price | number | No | Price of the product. Required if you provide a currency. |
currency | string | No | ISO 4217 currency code (e.g., USD, EUR). Required if you provide a price. |
isRestore | boolean | No | Deprecated. Triggers configured restore behavior for shared fetch tokens. |
presentedOfferingIdentifier | string | No | Identifier of the offering presented to the customer at the time of purchase. Attached to new transactions in this fetch token and exposed in ETL exports and webhooks. |
paymentMode | string | No | Payment mode for the introductory period. One of: pay_as_you_go, pay_up_front, free_trial. Defaults to free_trial when an introductory period is detected and no value is provided. |
introductoryPrice | number | No | Introductory price paid (if any). |
attributes | json | No | JSON object of subscriber attributes to set alongside the purchase. Each key maps to {"value": string, "updated_at_ms": number}. |
updatedAtMs | number | No | UNIX epoch in milliseconds used to resolve attribute conflicts at the request level. |
platform | string | Yes | Platform of the purchase. One of: ios, android, amazon, macos, uikitformac, stripe, roku, paddle. Sent as the X-Platform header (required by RevenueCat). |
| Parameter | Type | Description |
|---|
customer | object | Customer object returned at the top level of POST /v1/receipts (first_seen, last_seen, original_app_user_id, original_application_version, original_sdk_version, management_url, entitlements, original_purchase_date, request_date). Null when the response uses the value-wrapped envelope. |
subscriber | object | The updated subscriber object after recording the purchase |
Grant a promotional entitlement to a subscriber
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat secret API key (sk_...) |
appUserId | string | Yes | The app user ID of the subscriber |
entitlementIdentifier | string | Yes | The entitlement identifier to grant |
duration | string | No | Deprecated. Duration of the entitlement. Provide either duration or endTimeMs (endTimeMs preferred). One of: daily, three_day, weekly, two_week, monthly, two_month, three_month, six_month, yearly, lifetime |
endTimeMs | number | No | Absolute end time in milliseconds since Unix epoch. Use instead of duration to grant the entitlement until a specific timestamp. |
startTimeMs | number | No | Deprecated. Optional start time in milliseconds since Unix epoch, used with duration to determine expiration. Regardless of value, the entitlement is always granted immediately. |
| Parameter | Type | Description |
|---|
subscriber | object | The updated subscriber object after granting the entitlement |
Revoke all promotional entitlements for a specific entitlement identifier
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat secret API key (sk_...) |
appUserId | string | Yes | The app user ID of the subscriber |
entitlementIdentifier | string | Yes | The entitlement identifier to revoke |
| Parameter | Type | Description |
|---|
subscriber | object | The updated subscriber object after revoking the entitlement |
List all offerings configured for the project
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat API key |
appUserId | string | Yes | An app user ID to retrieve offerings for |
platform | string | No | X-Platform header value. One of: ios, android, amazon, stripe, roku, paddle. Required when using a legacy public API key; ignored with app-specific API keys. |
| Parameter | Type | Description |
|---|
current_offering_id | string | The identifier of the current offering |
offerings | array | List of offerings |
metadata | object | Offerings metadata |
Update custom subscriber attributes (e.g., $email, $displayName, or custom key-value pairs)
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat secret API key (sk_...) |
appUserId | string | Yes | The app user ID of the subscriber |
attributes | json | Yes | JSON object of attributes to set. Each key maps to an object with "value" (string; null or empty deletes the attribute) and "updated_at_ms" (Unix epoch ms used for conflict resolution — required). Example: {"$email": {"value": "user@example.com", "updated_at_ms": 1709195668093}} |
| Parameter | Type | Description |
|---|
updated | boolean | Whether the subscriber attributes were successfully updated |
app_user_id | string | The app user ID of the updated subscriber |
Defer a Google Play subscription by extending its billing date by a number of days (Google Play only)
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat secret API key (sk_...) |
appUserId | string | Yes | The app user ID of the subscriber |
productId | string | Yes | The Google Play product identifier of the subscription to defer (use the part before the colon for products set up after Feb 2023) |
extendByDays | number | No | Number of days to extend the subscription by (1-365). Provide either extendByDays or expiryTimeMs. |
expiryTimeMs | number | No | Absolute new expiry time in milliseconds since Unix epoch. Use instead of extendByDays to set an exact expiry. |
| Parameter | Type | Description |
|---|
subscriber | object | The updated subscriber object after deferring the Google subscription |
Refund a specific store transaction by its store transaction identifier and revoke access (subscription or non-subscription, last 365 days)
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat secret API key (sk_...) |
appUserId | string | Yes | The app user ID of the subscriber |
storeTransactionId | string | Yes | The store transaction identifier of the purchase to refund (e.g., GPA.3309-9122-6177-45730 for Google Play) |
| Parameter | Type | Description |
|---|
subscriber | object | The updated subscriber object after refunding the Google subscription |
Immediately revoke access to a Google Play subscription and issue a refund (Google Play only)
| Parameter | Type | Required | Description |
|---|
apiKey | string | Yes | RevenueCat secret API key (sk_...) |
appUserId | string | Yes | The app user ID of the subscriber |
productId | string | Yes | The Google Play product identifier of the subscription to revoke |
| Parameter | Type | Description |
|---|
subscriber | object | The updated subscriber object after revoking the Google subscription |
Trigger workflow when a subscriber makes their first purchase in RevenueCat
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., INITIAL_PURCHASE, RENEWAL) |
id | string | Unique event identifier |
app_id | string | RevenueCat app public identifier |
event_timestamp_ms | number | Timestamp (ms since epoch) when the event was generated |
app_user_id | string | Current App User ID |
original_app_user_id | string | First App User ID ever used |
aliases | json | All App User IDs ever used by the subscriber |
product_id | string | Product identifier |
new_product_id | string | Product identifier changed to (PRODUCT_CHANGE events only) |
period_type | string | Period type (TRIAL, INTRO, NORMAL, PROMOTIONAL, or PREPAID) |
purchased_at_ms | number | Purchase timestamp (ms since epoch) |
expiration_at_ms | number | Expiration timestamp (ms since epoch), nullable |
environment | string | Environment (SANDBOX or PRODUCTION) |
entitlement_id | string | Deprecated single entitlement identifier |
entitlement_ids | json | Associated entitlement identifiers |
presented_offering_id | string | Identifier of the offering presented to the user |
transaction_id | string | Store transaction ID |
original_transaction_id | string | Original subscription transaction ID |
is_family_share | boolean | Whether the purchase was family shared |
country_code | string | ISO country code of the subscriber |
currency | string | ISO 4217 currency code |
price | number | Price in USD |
price_in_purchased_currency | number | Price in the currency the purchase was made in |
store | string | Store the purchase was made on (e.g., APP_STORE) |
takehome_percentage | number | Estimated percentage of the price taken home after store commission |
tax_percentage | number | Estimated percentage taken as tax |
commission_percentage | number | Estimated percentage taken by the store as commission |
offer_code | string | Offer code applied to the purchase, if any |
subscriber_attributes | json | Subscriber attributes at the time of the event |
experiments | json | Experiments the subscriber was enrolled in |
cancel_reason | string | Reason for cancellation (CANCELLATION events only) |
expiration_reason | string | Reason for expiration (EXPIRATION events only) |
api_version | string | RevenueCat webhook API version |
event | json | Full RevenueCat event object |
Trigger workflow when a RevenueCat subscription renews
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., INITIAL_PURCHASE, RENEWAL) |
id | string | Unique event identifier |
app_id | string | RevenueCat app public identifier |
event_timestamp_ms | number | Timestamp (ms since epoch) when the event was generated |
app_user_id | string | Current App User ID |
original_app_user_id | string | First App User ID ever used |
aliases | json | All App User IDs ever used by the subscriber |
product_id | string | Product identifier |
new_product_id | string | Product identifier changed to (PRODUCT_CHANGE events only) |
period_type | string | Period type (TRIAL, INTRO, NORMAL, PROMOTIONAL, or PREPAID) |
purchased_at_ms | number | Purchase timestamp (ms since epoch) |
expiration_at_ms | number | Expiration timestamp (ms since epoch), nullable |
environment | string | Environment (SANDBOX or PRODUCTION) |
entitlement_id | string | Deprecated single entitlement identifier |
entitlement_ids | json | Associated entitlement identifiers |
presented_offering_id | string | Identifier of the offering presented to the user |
transaction_id | string | Store transaction ID |
original_transaction_id | string | Original subscription transaction ID |
is_family_share | boolean | Whether the purchase was family shared |
country_code | string | ISO country code of the subscriber |
currency | string | ISO 4217 currency code |
price | number | Price in USD |
price_in_purchased_currency | number | Price in the currency the purchase was made in |
store | string | Store the purchase was made on (e.g., APP_STORE) |
takehome_percentage | number | Estimated percentage of the price taken home after store commission |
tax_percentage | number | Estimated percentage taken as tax |
commission_percentage | number | Estimated percentage taken by the store as commission |
offer_code | string | Offer code applied to the purchase, if any |
subscriber_attributes | json | Subscriber attributes at the time of the event |
experiments | json | Experiments the subscriber was enrolled in |
cancel_reason | string | Reason for cancellation (CANCELLATION events only) |
expiration_reason | string | Reason for expiration (EXPIRATION events only) |
api_version | string | RevenueCat webhook API version |
event | json | Full RevenueCat event object |
Trigger workflow when a subscriber cancels a RevenueCat subscription
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., INITIAL_PURCHASE, RENEWAL) |
id | string | Unique event identifier |
app_id | string | RevenueCat app public identifier |
event_timestamp_ms | number | Timestamp (ms since epoch) when the event was generated |
app_user_id | string | Current App User ID |
original_app_user_id | string | First App User ID ever used |
aliases | json | All App User IDs ever used by the subscriber |
product_id | string | Product identifier |
new_product_id | string | Product identifier changed to (PRODUCT_CHANGE events only) |
period_type | string | Period type (TRIAL, INTRO, NORMAL, PROMOTIONAL, or PREPAID) |
purchased_at_ms | number | Purchase timestamp (ms since epoch) |
expiration_at_ms | number | Expiration timestamp (ms since epoch), nullable |
environment | string | Environment (SANDBOX or PRODUCTION) |
entitlement_id | string | Deprecated single entitlement identifier |
entitlement_ids | json | Associated entitlement identifiers |
presented_offering_id | string | Identifier of the offering presented to the user |
transaction_id | string | Store transaction ID |
original_transaction_id | string | Original subscription transaction ID |
is_family_share | boolean | Whether the purchase was family shared |
country_code | string | ISO country code of the subscriber |
currency | string | ISO 4217 currency code |
price | number | Price in USD |
price_in_purchased_currency | number | Price in the currency the purchase was made in |
store | string | Store the purchase was made on (e.g., APP_STORE) |
takehome_percentage | number | Estimated percentage of the price taken home after store commission |
tax_percentage | number | Estimated percentage taken as tax |
commission_percentage | number | Estimated percentage taken by the store as commission |
offer_code | string | Offer code applied to the purchase, if any |
subscriber_attributes | json | Subscriber attributes at the time of the event |
experiments | json | Experiments the subscriber was enrolled in |
cancel_reason | string | Reason for cancellation (CANCELLATION events only) |
expiration_reason | string | Reason for expiration (EXPIRATION events only) |
api_version | string | RevenueCat webhook API version |
event | json | Full RevenueCat event object |
Trigger workflow when a RevenueCat subscription expires
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., INITIAL_PURCHASE, RENEWAL) |
id | string | Unique event identifier |
app_id | string | RevenueCat app public identifier |
event_timestamp_ms | number | Timestamp (ms since epoch) when the event was generated |
app_user_id | string | Current App User ID |
original_app_user_id | string | First App User ID ever used |
aliases | json | All App User IDs ever used by the subscriber |
product_id | string | Product identifier |
new_product_id | string | Product identifier changed to (PRODUCT_CHANGE events only) |
period_type | string | Period type (TRIAL, INTRO, NORMAL, PROMOTIONAL, or PREPAID) |
purchased_at_ms | number | Purchase timestamp (ms since epoch) |
expiration_at_ms | number | Expiration timestamp (ms since epoch), nullable |
environment | string | Environment (SANDBOX or PRODUCTION) |
entitlement_id | string | Deprecated single entitlement identifier |
entitlement_ids | json | Associated entitlement identifiers |
presented_offering_id | string | Identifier of the offering presented to the user |
transaction_id | string | Store transaction ID |
original_transaction_id | string | Original subscription transaction ID |
is_family_share | boolean | Whether the purchase was family shared |
country_code | string | ISO country code of the subscriber |
currency | string | ISO 4217 currency code |
price | number | Price in USD |
price_in_purchased_currency | number | Price in the currency the purchase was made in |
store | string | Store the purchase was made on (e.g., APP_STORE) |
takehome_percentage | number | Estimated percentage of the price taken home after store commission |
tax_percentage | number | Estimated percentage taken as tax |
commission_percentage | number | Estimated percentage taken by the store as commission |
offer_code | string | Offer code applied to the purchase, if any |
subscriber_attributes | json | Subscriber attributes at the time of the event |
experiments | json | Experiments the subscriber was enrolled in |
cancel_reason | string | Reason for cancellation (CANCELLATION events only) |
expiration_reason | string | Reason for expiration (EXPIRATION events only) |
api_version | string | RevenueCat webhook API version |
event | json | Full RevenueCat event object |
Trigger workflow when a subscriber makes a non-renewing purchase in RevenueCat
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., INITIAL_PURCHASE, RENEWAL) |
id | string | Unique event identifier |
app_id | string | RevenueCat app public identifier |
event_timestamp_ms | number | Timestamp (ms since epoch) when the event was generated |
app_user_id | string | Current App User ID |
original_app_user_id | string | First App User ID ever used |
aliases | json | All App User IDs ever used by the subscriber |
product_id | string | Product identifier |
new_product_id | string | Product identifier changed to (PRODUCT_CHANGE events only) |
period_type | string | Period type (TRIAL, INTRO, NORMAL, PROMOTIONAL, or PREPAID) |
purchased_at_ms | number | Purchase timestamp (ms since epoch) |
expiration_at_ms | number | Expiration timestamp (ms since epoch), nullable |
environment | string | Environment (SANDBOX or PRODUCTION) |
entitlement_id | string | Deprecated single entitlement identifier |
entitlement_ids | json | Associated entitlement identifiers |
presented_offering_id | string | Identifier of the offering presented to the user |
transaction_id | string | Store transaction ID |
original_transaction_id | string | Original subscription transaction ID |
is_family_share | boolean | Whether the purchase was family shared |
country_code | string | ISO country code of the subscriber |
currency | string | ISO 4217 currency code |
price | number | Price in USD |
price_in_purchased_currency | number | Price in the currency the purchase was made in |
store | string | Store the purchase was made on (e.g., APP_STORE) |
takehome_percentage | number | Estimated percentage of the price taken home after store commission |
tax_percentage | number | Estimated percentage taken as tax |
commission_percentage | number | Estimated percentage taken by the store as commission |
offer_code | string | Offer code applied to the purchase, if any |
subscriber_attributes | json | Subscriber attributes at the time of the event |
experiments | json | Experiments the subscriber was enrolled in |
cancel_reason | string | Reason for cancellation (CANCELLATION events only) |
expiration_reason | string | Reason for expiration (EXPIRATION events only) |
api_version | string | RevenueCat webhook API version |
event | json | Full RevenueCat event object |
Trigger workflow when a subscriber changes their RevenueCat subscription product
| Parameter | Type | Description |
|---|
type | string | Event type (e.g., INITIAL_PURCHASE, RENEWAL) |
id | string | Unique event identifier |
app_id | string | RevenueCat app public identifier |
event_timestamp_ms | number | Timestamp (ms since epoch) when the event was generated |
app_user_id | string | Current App User ID |
original_app_user_id | string | First App User ID ever used |
aliases | json | All App User IDs ever used by the subscriber |
product_id | string | Product identifier |
new_product_id | string | Product identifier changed to (PRODUCT_CHANGE events only) |
period_type | string | Period type (TRIAL, INTRO, NORMAL, PROMOTIONAL, or PREPAID) |
purchased_at_ms | number | Purchase timestamp (ms since epoch) |
expiration_at_ms | number | Expiration timestamp (ms since epoch), nullable |
environment | string | Environment (SANDBOX or PRODUCTION) |
entitlement_id | string | Deprecated single entitlement identifier |
entitlement_ids | json | Associated entitlement identifiers |
presented_offering_id | string | Identifier of the offering presented to the user |
transaction_id | string | Store transaction ID |
original_transaction_id | string | Original subscription transaction ID |
is_family_share | boolean | Whether the purchase was family shared |
country_code | string | ISO country code of the subscriber |
currency | string | ISO 4217 currency code |
price | number | Price in USD |
price_in_purchased_currency | number | Price in the currency the purchase was made in |
store | string | Store the purchase was made on (e.g., APP_STORE) |
takehome_percentage | number | Estimated percentage of the price taken home after store commission |
tax_percentage | number | Estimated percentage taken as tax |
commission_percentage | number | Estimated percentage taken by the store as commission |
offer_code | string | Offer code applied to the purchase, if any |
subscriber_attributes | json | Subscriber attributes at the time of the event |
experiments | json | Experiments the subscriber was enrolled in |
cancel_reason | string | Reason for cancellation (CANCELLATION events only) |
expiration_reason | string | Reason for expiration (EXPIRATION events only) |
api_version | string | RevenueCat webhook API version |
event | json | Full RevenueCat event object |
- Category:
tools
- Type:
revenuecat
