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

Refund Saver 設定を更新する

ユーザーごとに返金の設定を個別に行い、ユーザーがデータ共有に同意したかどうかを記録します。この設定は App Store と Google Play の両方に適用される単一の値です。同意は App Store にのみ適用されます。各ストアにはアプリレベルのデフォルト設定があり、Adapty ダッシュボードからすべてのユーザーに対して変更できます。特定のユーザーの設定を調整するには、ダッシュボード、Adapty SDK、またはサーバーサイド API を使用してください。

Header parameters

adapty-customer-user-idstring

お客様のシステムにおける顧客の一意の ID。adapty-customer-user-id または adapty-profile-id のいずれかが必須です。

adapty-profile-idstring · uuid

お客様のシステムにおけるプロファイルの一意の ID。匿名プロファイルを扱う場合に最適です。adapty-customer-user-id または adapty-profile-id のいずれかが必須です。

Request body

custom_preferencestring

ユーザーに対して個別に返金設定を行います。この設定は、App Store および Google Play の両方におけるユーザーの返金リクエストに適用されます。Google は返金レビューにおいて decline、approve、または no preference のみを受け付けるため、この値が grant_prorated の場合、Adapty は Google Play に対して no preference を送信します。 - grant: すべての返金リクエストを承認します - grant_prorated: ユーザーがまだ消費していない購入分に対して返金を承認します - no_preference: 推奨を提供しません - decline: すべての返金リクエストを拒否します

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

consentboolean

ユーザーがデータ共有への同意を行ったかどうかを記録します。同意は App Store にのみ適用されます。 - true は、アプリ内返金リクエストを受け取った場合に、Apple にユーザーに関する情報を提供できることを意味します

Responses

設定の更新に成功しました

Schema
profile_idstringrequired

顧客プロファイルID

settingsobjectrequired

ユーザーの返金セーバー設定

consentboolean

ユーザーがAppleとデータを共有することに同意したかどうかを定義します(App Storeのみ)

custom_preferencestring

返金の優先設定

One of: "grant", "grant_prorated", "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ステータスコード