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

Get Refund Saver settings

Get the Refund Saver preference for this user - whether Adapty should ask the store to decline or approve their refund request. The preference is one value that applies to both the App Store and Google Play. Also get the data sharing preference for this user – whether the user gave their consent to share their data with Apple. Consent applies to the App Store only.

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.

Responses

Settings retrieved successfully

Schema

profile_idstringrequired

Customer profile ID

settingsobjectrequired

Refund saver settings for the user

consentboolean

Defines whether the user consented to share their data with Apple (App Store only)

custom_preferencestring

The refund preference

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

Example

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

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

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

curl --request GET \
  --url 'https://api.adapty.io/api/v2/server-side-api/purchase/profile/refund-saver/settings/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/profile/refund-saver/settings/', {
  method: 'GET',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
  },
});
const data = await response.json();

import requests

response = requests.get('https://api.adapty.io/api/v2/server-side-api/purchase/profile/refund-saver/settings/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
})
data = response.json()