TEST

Test event issued through the RevenueCat dashboard.

✅

✅

❌

❌

INITIAL_PURCHASE

A new subscription has been purchased.

✅

✅

✅

❌

NON_RENEWING_PURCHASE

A customer has made a purchase that will not auto-renew.

✅

✅

❌

✅

RENEWAL

An existing subscription has been renewed. This may occur at the end of the current billing period or later if a lapsed user re-subscribes.

✅

✅

✅

❌

PRODUCT_CHANGE

A subscriber has changed the product of their subscription.

✅

✅

✅

❌

CANCELLATION

A subscription has been cancelled.

✅

✅

✅

✅

UNCANCELLATION

Auto-renew status has been re-enabled for a subscription.

✅

✅

❌

❌

BILLING_ISSUE

There has been a problem trying to charge the subscriber. This does not mean the subscription has expired.

✅

✅

❌

❌

SUBSCRIBER_ALIAS

Deprecated. A new app_user_id has been registered for an existing subscriber.

type

String

Type of the event.

TEST

INITIAL_PURCHASE

NON_RENEWING_PURCHASE

RENEWAL

PRODUCT_CHANGE

CANCELLATION

BILLING_ISSUE

SUBSCRIBER_ALIAS

id

String

Unique identifier of the event.

event_timestamp_ms

Integer

The time that the event was generated. Does not necessarily coincide with when the action that triggered the event occurred (purchased, cancelled, etc).

app_user_id

String

Last seen app user id of the subscriber.

original_app_user_id

String

The first app user id used by the subscriber.

aliases

[String]

All app user ids ever used by the subscriber.

product_id

String

Product identifier of the subscription.

entitlement_ids

[String]

Entitlement identifiers of the subscription.

It can be NULL if the product_id is not mapped to any entitlements.

entitlement_id

String

Deprecated. See entitlement_ids.

Deprecated. See entitlement_ids.

period_type

String

Period type of the transaction.

TRIAL, for free trials.

INTRO, for introductory pricing.

NORMAL, standard subscription.

PROMOTIONAL, for subscriptions granted through RevenueCat.

purchased_at_ms

Integer

Time when the transaction was purchased. Measured in milliseconds since Unix epoch

expiration_at_ms

Integer

Expiration of the transaction. Measured in milliseconds since Unix epoch. Use this field to determine if a subscription is still active.

It can be NULL for non-subscription purchases.

store

String

Store the subscription belongs to.

PLAY_STORE

APP_STORE

STRIPE

MAC_APP_STORE

PROMOTIONAL

environment

String

Store environment.

SANDBOX

PRODUCTION

is_trial_conversion

Boolean

Only available for RENEWAL events.

Whether the previous transaction was a free trial or not.

true or false

cancel_reason

String

Only available for CANCELLATION events.

See Cancellation Reasons.

UNSUBSCRIBE

BILLING_ERROR

DEVELOPER_INITIATED

PRICE_INCREASE

CUSTOMER_SUPPORT

UNKNOWN

new_product_id

String

Product identifier of the new product the subscriber has switched to. Only available for App Store subscriptions and PRODUCT_CHANGE events.

presented_offering_id

String

Not available for apps using legacy entitlements.

The identifier for the offering that was presented to the user during their initial purchase.

price

Double

The USD price of the transaction.

Can be NULL if the price is unknown, and 0 for free trials.

Can be negative for refunds.

currency

String

The ISO 4217 currency code that the product was purchased in.

USD, CAD, etc.

Can be NULL if the currency is unknown.

price_in_purchased_currency

Double

The price of the transaction in the currency the product was purchased in.

Can be NULL if the price is unknown, and 0 for free trials.

Can be negative for refunds.

takehome_percentage

Double

The estimated percentage of the transaction price that will be paid out to developers after the Apple/Google platform fee.

0.7 or 0.85

subscriber_attributes

Map of attribute names to attribute objects.

For more details see the subscriber attributes guide.

transaction_id

String

Transaction identifier from Apple/Google.

original_transaction_id

String

transaction_id of the original transaction in the subscription from Apple/Google.

UNSUBSCRIBE

Subscriber cancelled voluntarily. This event fires when a user unsubscribes, not when the subscription expires.

✅

✅

✅

❌

BILLING_ERROR

Apple or Google could not charge the subscriber using their payment method.

✅

✅

❌

❌

DEVELOPER_INITIATED

Developer cancelled the subscription.

❌

✅

❌

✅

PRICE_INCREASE

Subscriber did not agree to a price increase.

✅

❌

❌

❌

CUSTOMER_SUPPORT

Customer cancelled through Apple support and received a refund, or a Google subscription was refunded through RevenueCat.

✅

✅

❌

❌

UNKNOWN

Apple did not provide the reason of the cancellation.

✅

❌

❌

❌