ConsumptionRequest

The request body that contains consumption information for an In-App Purchase.

Declaration

object ConsumptionRequest

Properties

Name	Type	Description
`customerConsented`	`customerConsented`	(Required) A Boolean value of `true` or `false` that indicates whether the customer consented to provide consumption data.
`consumptionPercentage`	`consumptionPercentage`	An integer that indicates the percentage of the In-App Purchase the customer consumed, in milliunits.
`deliveryStatus`	`deliveryStatus`	(Required) A value that indicates whether the app successfully delivered an In-App Purchase that works properly.
`refundPreference`	`refundPreference`	A value that indicates your preference, based on your operational logic, as to whether the App Store should grant the refund.
`sampleContentProvided`	`sampleContentProvided`	(Required) 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.

Discussion

Use ConsumptionRequest to provide information about the customer’s In-App Purchase when you call the Send Consumption Information endpoint.

You can provide consumption information for any type of product: consumable, non-consumable, non-renewing subscription, and auto-renewable subscription.

Consider the following constraints when providing an optional refundPreference:

The system supports the GRANT_FULL and DECLINE values for all product types.
If you choose GRANT_PRORATED for an auto-renewable subscription, don’t include a consumptionPercentage. The system automatically calculates the percentage.

If the deliveryStatus isn’t DELIVERED, set the consumptionPercentage to 0; otherwise the request fails with an error.

ConsumptionRequest

Declaration

Properties

Discussion

Topics

Consumption data types

See Also

Consumption information