ConsumptionRequestV1
The request body containing consumption information.
Declaration
object ConsumptionRequestV1Properties
| Name | Type | Description |
|---|---|---|
accountTenure | accountTenure | (Required) The age of the customer’s account. |
appAccountToken | appAccountToken | (Required) The UUID of the in-app user account that completed the in-app purchase transaction. |
consumptionStatus | consumptionStatus | (Required) A value that indicates the extent to which the customer consumed the in-app purchase. |
customerConsented | customerConsented | (Required) A Boolean value of Note: The App Store server rejects requests that have a customerConsented value other than |
deliveryStatus | deliveryStatusV1 | (Required) A value that indicates whether the app successfully delivered an in-app purchase that works properly. |
lifetimeDollarsPurchased | lifetimeDollarsPurchased | (Required) A value that indicates the total amount, in USD, of in-app purchases the customer has made in your app, across all platforms. |
lifetimeDollarsRefunded | lifetimeDollarsRefunded | (Required) A value that indicates the total amount, in USD, of refunds the customer has received, in your app, across all platforms. |
platform | platform | (Required) A value that indicates the platform on which the customer consumed the in-app purchase. |
playTime | playTime | (Required) A value that indicates the amount of time that the customer used the app. |
refundPreference | refundPreferenceV1 | A value that indicates your preference, based on your operational logic, as to whether Apple should grant the refund. |
sampleContentProvided | sampleContentProvided | (Required) A Boolean value of |
userStatus | userStatus | (Required) The status of the customer’s account. |
Mentioned in
Discussion
Use ConsumptionRequestV1 to provide information about the customer’s consumable in-app purchase or auto-renewable subscription when you call the Send Consumption Information V1 endpoint.
To create a valid request and avoid an HTTP 400 Bad Request error, ConsumptionRequestV1 must contain all the required fields with proper data types and valid values. However, you can choose whether or not to provide information for most fields. Most fields have a valid option if you choose not to provide the information.
For example, if you choose not to provide information for the accountTenure field, set accountTenure to 0. If you choose not to provide information for the appAccountToken field, set its value to an empty string. Refer to each field’s documentation for the list of valid values, including the undeclared value where available.
The App Store server rejects requests that have a customerConsented value other than true by returning an HTTP 400 error with an InvalidCustomerConsentedError.
Provide the app account token in a consumption request
The ConsumptionRequestV1 request body requires that you set the appAccountToken to a valid value of either a UUID or an empty string. Set the appAccountToken value to the value you received in the CONSUMPTION_REQUEST notification, or, if you choose not to provide this information, set the value to an empty string.
If you receive a CONSUMPTION_REQUEST notification for a transaction, find its associated appAccountToken value as follows:
If you receive App Store Server Notifications V2, the
appAccountTokenvalue is in JWSTransactionDecodedPayload.If you receive App Store Server Notifications Version 1, the
appAccountTokenvalue is in unified_receipt.Latest_receipt_info.
The appAccountToken value may be an empty string if your app doesn’t use app account tokens.
For more information about App Store Server Notifications versions, see App Store Server Notifications changelog.