Contents

refundPreference

A value that indicates your preferred outcome for the refund request.

Declaration

string refundPreference

Possible Values

DECLINE

You prefer that the App Store declines the refund.

GRANT_FULL

You prefer that the App Store grants the refund in full.

GRANT_PRORATED

You prefer that the App Store grants a prorated refund.

Discussion

Use these values in the refundPreference field of a ConsumptionRequest.

The following constraints apply to the GRANT_PRORATED option:

  • If the product is a consumable or non-consumable In-App Purchase or a non-renewing subscription, you may include a consumptionPercentage value in the ConsumptionRequest.

  • If the product is an auto-renewable subscription, don’t include a consumptionPercentage value in the ConsumptionRequest. The system calculates the consumption automatically for auto-renewable subscriptions.

Your refund preference is one of a variety of factors that the App Store uses to inform its refund decisions.

See Also

Consumption data types