Sign in

v1

latestOpenAPI 3.1.02026-08-061945115.8 KB
Refund Saver

Set Refund Saver settings

Set the refund preference individually for the user and record if the user gave their consent to share their data. By default, Refund Saver always asks Apple to decline a user's refund request. You can change this default behavior for all users in the Adapty Dashboard, or adjust it for a specific user using the Dashboard, the Adapty SDK, or the server-side API.

post/api/v2/server-side-api/purchase/profile/refund-saver/settings/

Headers

adapty-customer-user-idstring

The unique ID of the customer in your system. Either adapty-customer-user-id or adapty-profile-id is required.

adapty-profile-idstring uuid

The unique ID of the profile in your system. Your best option if you are working with anonymous profiles. Either adapty-customer-user-id or adapty-profile-id is required.

Request body

custom_preference'grant' | 'no_preference' | 'decline' nullable

Set the refund preference individually for the user.

  • grant: approve each refund request
  • no_preference: do not provide any recommendations
  • decline: decline each refund request
consentboolean nullable

Record if the user gave their consent to share their data.

  • true means that if you receive an in-app refund request, you may provide Apple with information about the user

Example request

{
  "custom_preference": "grant",
  "consent": true
}

Response

Settings updated successfully

profile_idstring uuid required

Customer profile ID