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

Set Refund Saver settings

Copy as Markdown

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.

Header parameters

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_preferencestring

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

One of: "grant", "no_preference", "decline"

consentboolean

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

Responses

Settings updated successfully

Schema
profile_idstringrequired

Customer profile ID

settingsobjectrequired

Refund saver settings for the user

consentboolean

Defines whether the user consented to share their data

custom_preferencestring

The refund preference

One of: "grant", "no_preference", "decline"

Example 
{
  "profile_id": "e5aab402-b1bd-4039-b632-57a91ebc0779",
  "settings": {
    "consent": true,
    "custom_preference": "grant"
  }
}

Bad request

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Example 
{
  "errors": [
    "Profile does not exist"
  ],
  "error_code": "profile_does_not_exist",
  "status_code": 400
}

Unauthorized

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code

Example 
{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

Internal server error

Schema
errorsarray of objectrequired
sourcestring

Source of the error

errorsarray of string

Array of error messages

error_codestringrequired

Short error name

status_codeintegerrequired

HTTP status code