The Scheduled Data Export integration is available on the Pro plan.
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_conversionhave previously been provided with the strings
fto represent true and false, but they will now be delivered as true boolean fields with
falseas the set values.
- Fields containing arrays or JSON objects (
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 (
]) instead of curly brackets (
}). Fields containing JSON objects (
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.
When a transaction is refunded, the current
price_in_purchased_currency fields will be set to
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_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 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 (
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
product_durationdoes 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_durationwill 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_identifieris not easily interpretable.
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.
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.
All dates and times are provided in UTC.
|Header||Description||Type||Example value||Can be null|
|Can be used as a unique user identifier to find all of a user's transactions.||string|
|Can be used together with ||string|
|Store country of a transaction when known, or an IP-based estimate of a subscriber's country when not known.||string||✅|
|The product identifier that was purchased.||string|
|The display name of the product identifier if one has been set||string||✅|
|The standard duration of the product if one is known by RevenueCat. May be null if RevenueCat does not know the authoritative duration.||string||✅|
|Purchase time of transaction.||datetime|
|Expected expiration time of subscription. Null when |
For Google Play,
|Expiration 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.||datetime||✅|
|Single reference point of a subscriber’s expiration and entitlement revocation; inclusive of each store’s logic for refunds, grace periods, etc.||datetime||✅|
|The source of the transaction. Can be ||string|
|The 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.||float||✅|
|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.||float||✅|
|[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
|The 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.||float|
|The 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.||float|
|orderId or transaction_identifier. Can be used as unique id.||string|
|orderId of first purchase or ||string|
|When a refund was detected, ||datetime||✅|
|When we detected an unsubscribe (opt-out of auto renew).||datetime||✅|
|When we detected billing issues, ||datetime||✅|
|The currency that was used for the transaction.||string||✅|
|The 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.||float||✅|
|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.||float||✅|
|An array of entitlements that the transaction unlocked or ||string array||✅|
|Always starts at 1. Trial conversions are counted as renewals. ||integer|
|The offering presented to users.||string||✅|
|Will be |
|The reserved subscriber attributes set for the subscriber. Keys begin with ||string JSON||✅|
|The custom attributes set for the subscriber.||string JSON||✅|
|Last seen platform of the subscriber.||string||✅|
|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.
|The value of the Experiment variant that the subscriber is or was enrolled in. |
Learn more about Experiments here.
|The last time an attribute of the transaction was modified.||datetime|
*Newly added fields for Version 4
To learn more about how to use our transaction data, or get started with sample queries, click here.
Updated about 8 hours ago