Skip to content

Update Consumption Request docs #1345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RPallas92 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Consumption Request docs #1345

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 7 additions & 15 deletions docs/platform-resources/apple-platform-resources/handling-refund-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,28 +60,20 @@ Here's a template to help get you started:
>
> By using our app and making in-app purchases, you consent to our sharing of data regarding your usage and consumption of purchased content with Apple, as part of our efforts to resolve refund requests. This information may include details about how you have accessed and interacted with the purchased content. The purpose of sharing this data is to help Apple make an informed decision regarding refund requests. We ensure that such data sharing is done in compliance with Apple's policies and only as necessary to process your requests.

For general guidelines from Apple, visit their [documentation](https://developer.apple.com/documentation/appstoreserverapi/send_consumption_information#3921151).
Copy link
Contributor Author

@RPallas92 RPallas92 Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this points to v1

For general guidelines from Apple, visit their [documentation](https://developer.apple.com/documentation/appstoreserverapi/send-consumption-information).

If you have a use case where you only update your Terms & Conditions (or an equivalent document) for new customers, while existing customers remain on the original terms, contact [RevenueCat support](https://app.revenuecat.com/settings/support) for assistance.

## Data RevenueCat sends to Apple

Below are the [properties](https://developer.apple.com/documentation/appstoreserverapi/consumptionrequest) and data that RevenueCat will send to Apple when a refund request comes in.

| Property | Description | What RevenueCat sends |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| accountTenure | The age of the customer’s account. | <ul><li>If customer exists in RC: Calculate age based on the creation date of that customer and assess the [range](https://developer.apple.com/documentation/appstoreserverapi/accounttenure). </li><li>If customer does not exist in RC: 0 (_undeclared_)</li></ul> |
| appAccountToken | The optionally UUID of the in-app user account that completed the in-app purchase transaction. | Empty string |
| consumptionStatus | A value that indicates the extent to which the customer consumed the in-app purchase. | 0 (_undeclared_) |
| customerConsented | A Boolean value of true or false that indicates whether the customer consented to provide consumption data. | true, by turning this on this functionality, we assume you are asking your customers for consent. |
| deliveryStatus | A value that indicates whether the app successfully delivered an in-app purchase that works properly. | <ul><li> If the transaction exists in RC: 0 (_The app delivered the consumable in-app purchase and it’s working properly._) </li><li>If the transaction does not exist in RC: 5 (_The app didn’t deliver the consumable in-app purchase for other reasons._)</li></ul> |
| lifetimeDollarsPurchased | A value that indicates the total amount, in USD, of in-app purchases the customer has made in your app, across all platforms. | Calculate the total of non-refunded transactions in USD and assess the [range](https://developer.apple.com/documentation/appstoreserverapi/lifetimedollarspurchased). |
| lifetimeDollarsRefunded | A value that indicates the total amount, in USD, of refunds the customer has received, in your app, across all platforms. | Calculate the total of refunded transactions in USD and assess the [range](https://developer.apple.com/documentation/appstoreserverapi/lifetimedollarsrefunded). |
| platform | A value that indicates the platform on which the customer consumed the in-app purchase. | <ul><li> If your customer only has transactions from the App Store: 1 (_An Apple platform_) </li><li>If your customer has transactions from multiple stores: 0 (_undeclared_)</li></ul> |
| playTime | A value that indicates the amount of time that the customer used the app. | 0 (_undeclared_) |
| refundPreference | A value that indicates your preference, based on your operational logic, as to whether Apple should grant the refund. | <ul><li> The value for your customer's reserved customer attribute `$appleRefundHandlingPreference` </li><li>Otherwise, we will fall back to the option you chose in the dropdown selector</li></ul> |
| sampleContentProvided | A Boolean value of true or false that indicates whether you provided, prior to its purchase, a free sample or trial of the content, or information about its functionality. | true |
| userStatus | The status of the customer’s account. | <ul><li> If the transaction exists in RC: 1 (_The customer’s account is active._)</li><li>If the transaction does not exist in RC: 0 (_undeclared_)</li></ul> |
| Property | Description | What RevenueCat sends |
Copy link
Contributor Author

@RPallas92 RPallas92 Jan 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that the new API accepts 5 fields, but I am only documenting 4 of them.

The field I am not documenting is consumptionPercentage. It is only needed when refundPreference is partial refund. However, we do not support this in the dashboard (link to discussion)

| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| customerConsented | A Boolean value that indicates whether the customer consented to provide consumption data. | `true`, by enabling this functionality, we assume you are asking your customers for consent. |
| deliveryStatus | A value that indicates whether the app successfully delivered an in-app purchase that works properly. | <ul><li>If the transaction exists in RC: `DELIVERED` (_The app delivered the In-App Purchase and it's working properly._)</li><li>If the transaction does not exist in RC: `UNDELIVERED_OTHER` (_The app didn't deliver the In-App Purchase for other reasons._)</li></ul> |
| sampleContentProvided | A Boolean value that indicates whether you provided, prior to its purchase, a free sample or trial of the content, or information about its functionality. | `true` |
| refundPreference | A value that indicates your preference, based on your operational logic, as to whether Apple should grant the refund. | <ul><li>The value mapped from your customer's reserved customer attribute `$appleRefundHandlingPreference`</li><li>Otherwise, we will fall back to the option you chose in the dropdown selector</li></ul> |

:::info Share your feedback
If you have any feedback about this feature, please reach out to our [RevenueCat support](https://app.revenuecat.com/settings/support) and we'll be happy to discuss your feedback or feature request!
Expand Down