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

设置退款保护设置

为用户单独设置退款偏好并记录用户是否同意共享其数据。默认情况下,退款保护功能始终要求 Apple 拒绝用户的退款请求。您可以在 Adapty 看板中更改所有用户的默认行为,或通过看板、Adapty SDK 或服务端 API 为特定用户调整此设置。

Header parameters

adapty-customer-user-idstring

您系统中客户的唯一 ID。adapty-customer-user-idadapty-profile-id 二选一必填。

adapty-profile-idstring · uuid

您系统中用户画像的唯一 ID。如果您正在处理匿名用户画像,这是最佳选择。adapty-customer-user-idadapty-profile-id 二选一必填。

Request body

custom_preferencestring

为用户单独设置退款偏好。 - grant:批准每个退款请求 - no_preference:不提供任何建议 - decline:拒绝每个退款请求

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

consentboolean

记录用户是否同意共享其数据。 - true 表示如果您收到应用内退款请求,您可以向 Apple 提供有关该用户的信息

Responses

设置更新成功

Schema
profile_idstringrequired

客户用户画像 ID

settingsobjectrequired

用户的退款保护设置

consentboolean

定义用户是否同意共享其数据

custom_preferencestring

退款偏好

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

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

请求错误

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

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

未授权

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

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

服务器内部错误

Schema
errorsarray of objectrequired
sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码