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

Refund Saver設定を行う

ユーザーごとに返金の設定を行い、ユーザーがデータ共有に同意したかどうかを記録します。デフォルトでは、Refund Saverはトランザクションに対する最初の返金リクエストを拒否するようAppleに求め、同一トランザクションへの繰り返しのリクエストはすべて承認するよう求めます。このデフォルトの動作は、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

ユーザーに対して個別に返金の設定を行います。 - grant: すべての返金リクエストを承認する - grant_prorated: ユーザーがまだ消費していない購入分に対して返金を承認する - no_preference: 推奨事項を提供しない - decline: すべての返金リクエストを拒否する

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

consentboolean

ユーザーがデータ共有に同意したかどうかを記録します。 - true はアプリ内返金リクエストを受信した場合に、ユーザーに関する情報を Apple に提供できることを意味します

Responses

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

Schema

profile_idstringrequired

顧客プロファイルID

settingsobjectrequired

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

consentboolean

ユーザーがデータ共有に同意したかどうかを定義します

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ステータスコード

Try it

Authorization

Header parameters

adapty-customer-user-id

adapty-profile-id

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/purchase/profile/refund-saver/settings/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "custom_preference": "grant",
    "consent": true
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/profile/refund-saver/settings/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "custom_preference": "grant",
    "consent": true
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/purchase/profile/refund-saver/settings/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "custom_preference": "grant",
      "consent": True
    })
data = response.json()