Data Export Version 4

Available since June 2023 (latest version)

๐Ÿ‘

The Scheduled Data Export integration is available on the Pro plan.

Version 4 Change Log

Data format improvements

๐Ÿšง

Please ensure that your data ingestion pipeline is setup to handle these format changes before updating to Version 4.

  • Boolean fields such as is_trial_conversion have previously been provided with the strings t and f to represent true and false, but they will now be delivered as true boolean fields with true or false as the set values.
  • Fields containing arrays or JSON objects (reserved_subscriber_attributes, custom_subscriber_attributes, and entitlement_identifiers) will have the values within each key/value pair enclosed in quotes to prevent issues when ingesting the data.
  • Last, for standardization, fields containing arrays (only entitlement_identifiers) have also been updated to contain the array within square brackets ([ and ]) instead of curly brackets ({ and }). Fields containing JSON objects (reserved_subscriber_attributes and custom_subscriber_attributes) will continue to use curly brackets

๐Ÿ“˜

The data table below contains sample values for each field to help ensure your pipeline is setup correctly.

Newly added fields

Measuring gross revenue

When a transaction is refunded, the current price_in_usd and price_in_purchased_currency fields will be set to 0 while refunded_at is set to mark the time of the refund.

To instead equip you to measure gross revenue before refunds, we've introduced new purchase_price_in_usd and purchase_price_in_purchased_currency fields which will remain set at the original purchase price even after a refund.

By sourcing your analysis' with these fields, you'll be able to measure gross revenue before refunds.

Country fields

country has been updated to equal the store country of a given transaction when it is known, and to fall back to an IP-based estimated country when it is not known.

  • The store country of a transaction is the most accurate way to group a subscription by country because it dictates the price of the subscription, the available offers, how price changes will be handled, etc.
  • Update to iOS SDK version 3.14 and up to ensure store country can be captured by RevenueCat.

country_source has been added to distinguish between country values that represent the store country of a transaction (from_sdk), and those that have been set through an IP-based estimate (estimated).

Product dimensions

product_duration represents the standard duration of a subscription product, set using ISO 8601 values (e.g. P1M for a 1 month subscription, P1Y for a 1 year subscription, etc).

  • Trial period or introductory period lengths are not reported through this field. Therefore, when either is_trial_period or is_in_intro_offer_period are true, the product_duration does not represent the duration of that specific transaction. It represents the standard duration of the underlying product that has been subscribed to.
  • There may be products where RevenueCat does not authoritatively know the standard duration, such as Stripe products which may have multiple prices (and therefore durations) associated with them. In these cases, product_duration will be null.
    • In our data features, we handle these cases by estimating product duration.

product_display_name represents the display name that may be set for a product in the RevenueCat Dashboard.

  • Setting a display name may be especially useful for products on stores like Stripe where the product_identifier is not easily interpretable.

Experiment fields

experiment_id represents the UUID of a RevenueCat Experiment that the associated App User ID was enrolled in.

experiment_variant represents the variant of the experiment that the associated App User ID was assigned to.

๐Ÿ‘

Experiments is available on the Pro plan. Get started with Experiments here.

Change tracking

updated_at represents the last time an attribute of the transaction was modified (e.g. after a subscriber disables their auto-renewal and a cancellation_date is set). This can be used to more easily capture changes to individual transactions between exports.

Full export format

๐Ÿ“˜

All dates and times are provided in UTC.

HeaderDescriptionTypeExample valueCan be null
rc_original_app_user_idCan be used as a unique user identifier to find all of a user's transactions.string$RCAnonymousID:87c6049c58069238dce29853916d624c
rc_last_seen_app_user_id_aliasCan be used together with rc_original_app_user_id to match transactions with user identifiers in your systems.string$RCAnonymousID:87c6049c58069238dce29853916d624c
countryStore country of a transaction when known, or an IP-based estimate of a subscriber's country when not known.stringGBโœ…
country_source*from_sdk when the store country of a transaction is known, or estimated when country is sourced from an IP-based estimate.stringfrom_sdkโœ…
product_identifierThe product identifier that was purchased.stringrc_subscription_monthly
product_display_name*The display name of the product identifier if one has been setstringMonthly $9.99โœ…
product_duration*The standard duration of the product if one is known by RevenueCat. May be null if RevenueCat does not know the authoritative duration.

product_duration does not represent the trial or introductory period length of a transaction, it only represents the standard duration of the product that's been subscribed to.
stringP1Mโœ…
start_timePurchase time of transaction.datetime2023-01-01 08:27:06
end_timeExpected expiration time of subscription. Null when is_auto_renewable = false
For Google Play, end_time can be before start_time to indicate an invalid transaction (e.g. billing issue).
datetime2023-02-01 08:27:06โœ…
grace_period_end_timeExpiration time of a grace period (if applicable) for a subscription. Will remain set while a subscription is in its grace period, or if it exited its grace period without renewing. Null when a subscription is not in a grace period or expiration was not due to a grace period.datetime2023-02-17 08:27:06โœ…
effective_end_timeSingle reference point of a subscriberโ€™s expiration and entitlement revocation; inclusive of each storeโ€™s logic for refunds, grace periods, etc.datetime2023-02-17 08:27:06โœ…
storeThe source of the transaction. Can be app_store, play_store, stripe, or promotional.stringplay_store
is_auto_renewabletrue for auto-renewable subscriptions, false otherwise.booleantrue
is_trial_periodtrue if the transaction was a trial.booleanfalse
is_in_intro_offer_periodtrue if the transaction is in an introductory offer period.booleanfalse
is_sandboxtrue for transactions made in a sandbox environment.booleanfalse
price_in_usdThe revenue (converted to USD) generated from the transaction after accounting for full and partial refunds. Can be null if product prices haven't been collected from the user's device. float0โœ…
purchase_price_in_usd*The gross revenue (converted to USD) generated from the transaction. Remains set for refunded transactions. Can be null if product prices haven't been collected from the user's device.float9.99โœ…
takehome_percentage[DEPRECATED] The estimated percentage of the transaction price that will be paid out to developers after commissions, but before VAT and DST taxes are taken into account. (will be either 0.7 or 0.85)

We recommend using tax_percentage and commission_percentage to calculate proceeds instead. Learn more here.
float0.7
tax_percentageThe portion of a transactionโ€™s price that will be deducted by the store for taxes. VAT & Digital Services Taxes may be withheld by stores depending on the store and country. To learn more about how RevenueCat estimates taxes, click here.float0.1442
commission_percentageThe portion of a transactionโ€™s price that will be detected by the store for commission. In stores where taxes are deducted before commission, this value will not equal the published commission from a store, because that commission is calculated on the post-tax revenue.float0.15
store_transaction_idorderId or transaction_identifier. โ€‹Can be used as unique id.string123456789012345
original_store_transaction_idorderId of first purchase or original_transaction_id. Can be used to find all related transactions for a single subscription.string011223344556677
refunded_atWhen a refund was detected, null if none was detected. Is not set in the case of upgraded transactions for which the App Store issues a partial refund.datetime2023-02-20 05:47:55โœ…
unsubscribe_detected_atWhen we detected an unsubscribe (opt-out of auto renew).datetime2023-02-16 14:17:10โœ…
billing_issues_detected_atWhen we detected billing issues, null if none was detected.datetime2023-02-01 08:27:15โœ…
purchased_currencyThe currency that was used for the transaction.stringGBPโœ…
price_in_purchased_currencyThe revenue (in the purchased currency) generated from the transaction after accounting for full and partial refunds. Can be null if product prices haven't been collected from the user's device.float0โœ…
purchase_price_in_purchased_currency*The gross revenue (in the purchased currency) generated from the transaction. Remains set for refunded transactions. Can be null if product prices haven't been collected from the user's device.float3.99โœ…
entitlement_identifiersAn array of entitlements that the transaction unlocked or null if it didn't unlock any entitlements.string array"[""membership"", ""full_access""]"โœ…
renewal_numberAlways starts at 1. Trial conversions are counted as renewals. is_trial_conversion is used to signify whether a transaction was a trial conversion.integer2
is_trial_conversionIf true, this transaction is a trial conversion.booleantrue
presented_offeringThe offering presented to users.stringDefault Offeringโœ…
ownership_typeWill be PURCHASED when a recorded transaction results from the subscriberโ€™s direct purchase of it, or FAMILY_SHARED when a recorded transaction results from the subscriber having received it through Family Sharing.

NOTE: The FAMILY_SHARED designation is only supported on App Store transactions.
stringPURCHASEDโœ…
reserved_subscriber_attributesThe reserved subscriber attributes set for the subscriber. Keys begin with $.string JSON"{""$ip"": {""value"": ""203.78.120.117"", ""updated_at_ms"": 1672549200}, ""$gpsAdId"": {""value"": ""80480bdc-06e0-11ee-be56-0242ac120002"", ""updated_at_ms"": 1672549200}, ""$androidId"": {""value"": ""12345a9876b4c123"", ""updated_at_ms"": 1673097132390}}"โœ…
custom_subscriber_attributesThe custom attributes set for the subscriber.string JSON"{""feature_setting"": {""value"": ""1"", ""updated_at_ms"": 1672549200}, ""survey_response"": {""value"": ""2"", ""updated_at_ms"": 1599112814785}}"โœ…
platformLast seen platform of the subscriber.stringandroidโœ…
experiment_id*The unique ID of the Experiment that the subscriber is or was enrolled in. Will be null if the subscriber has not been enrolled in an experiment.

Learn more about Experiments here.
stringprexp3a8a234abcโœ…
experiment_variant*The value of the Experiment variant that the subscriber is or was enrolled in. a represents the Control, and b represents the Treatment. Will be null if the subscriber has not been enrolled in an experiment.

Learn more about Experiments here.
stringaโœ…
updated_at*The last time an attribute of the transaction was modified.datetime2023-02-20 05:47:55

*Newly added fields for Version 4

To learn more about how to use our transaction data, or get started with sample queries, click here.