POST /api/v2/server-side-api/purchase/set/transaction/

トランザクションを設定する

Adapty にアプリのエンドユーザーの新しいトランザクションを作成し、アクセスレベルを付与します。このメソッドで作成されたトランザクションはアナリティクスおよびイベントフィードに表示され、すべてのインテグレーションに送信されます。

既存のサブスクリプションの更新: 新しい subscription_renewed イベントを発生させずに billing_issue_detected_at または renew_status_changed_at を更新するには、既存の store_transaction_id を同じ store_original_transaction_id の下で再利用してください。新しい store_transaction_id を送信すると新しいトランザクションとして扱われ、subscription_renewed イベントが発火します。

Header parameters

adapty-customer-user-idstring

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

adapty-profile-idstring

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

Request body

Option 1 — object

買い切り購入のトランザクションデータ

purchase_typestringrequired

購入の種別

One of: "one_time_purchase"

storestringrequired

購入が行われたストア。一般的な値には app_store、play_store、stripe、paddle、またはカスタムストア識別子が含まれます

environmentstring

購入が行われた環境

One of: "Production", "Sandbox"

store_product_idstringrequired

ストアにおけるプロダクト ID

store_transaction_idstringrequired

ストアにおけるトランザクション ID。最大 50 文字。PayPal および一部のカスタムストアのトランザクション ID はこれを超える場合があります。その場合は送信前に値をトリミングまたはハッシュ化してください。そうしないとリクエストが失敗します。

store_original_transaction_idstringrequired

ストアにおける元のトランザクション ID

is_family_sharedboolean

ファミリー共有の購入かどうか

priceobjectrequired

countrystringrequired

国コード

currencystringrequired

通貨コード

valuenumberrequired

価格の値

purchased_atstringrequired

購入が行われた日時

variation_idstring

A/B テスト用のバリエーション ID

offerobject

categorystringrequired

オファーのカテゴリ

One of: "introductory", "promotional", "offer_code", "win_back"

typestringrequired

オファーの種別

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

オファー ID

refunded_atstring

購入が返金された日時

cancellation_reasonstring

キャンセルの理由

One of: "billing_error", "cancelled_by_developer", "new_subscription_replace", "price_increase", "product_was_not_available", "refund", "unknown", "upgraded", "voluntarily_cancelled", "adapty_revoked"

Option 2 — object

サブスクリプション購入のトランザクションデータ

purchase_typestringrequired

購入の種別

One of: "subscription"

storestringrequired

購入が行われたストア。一般的な値には app_store、play_store、stripe、paddle、またはカスタムストア識別子が含まれます

environmentstring

購入が行われた環境

One of: "Production", "Sandbox"

store_product_idstringrequired

ストアにおけるプロダクト ID

store_transaction_idstringrequired

store_original_transaction_idstringrequired

ストアにおける元のトランザクション ID

is_family_sharedboolean

ファミリー共有の購入かどうか

priceobjectrequired

countrystringrequired

国コード

currencystringrequired

通貨コード

valuenumberrequired

価格の値

purchased_atstringrequired

購入が行われた日時

variation_idstring

A/B テスト用のバリエーション ID

offerobject

categorystringrequired

オファーのカテゴリ

One of: "introductory", "promotional", "offer_code", "win_back"

typestringrequired

オファーの種別

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

オファー ID

refunded_atstring

購入が返金された日時

cancellation_reasonstring

キャンセルの理由

originally_purchased_atstringrequired

サブスクリプションが最初に購入された日時

expires_atstringrequired

サブスクリプションの有効期限

renew_statusbooleanrequired

サブスクリプションが自動更新されるかどうか

renew_status_changed_atstring

更新ステータスが変更された日時

billing_issue_detected_atstring

請求問題が検出された日時

grace_period_expires_atstring

グレース期間の終了日時

Responses

トランザクションが正常に記録されました

Schema

dataobjectrequired

app_idstringrequired

アプリの内部 ID

profile_idstringrequired

Adapty プロファイル ID

customer_user_idstringrequired

お客様のシステムにおけるユーザーの ID

total_revenue_usdnumberrequired

プロファイルで獲得した USD 換算の総収益を表す浮動小数点値

segment_hashstringrequired

内部パラメータ

timestampintegerrequired

レスポンス時刻（ミリ秒）。競合状態の解決に使用します

custom_attributesarray of objectrequired

プロファイルに設定できるカスタム属性は最大 30 個です

keystringrequired

キーは 30 文字以下の文字列である必要があります。英字、数字、ダッシュ、ピリオド、アンダースコアのみ使用できます

valuestring | numberrequired

属性値は 50 文字以下である必要があります。文字列と浮動小数点数のみ使用できます

access_levelsarray of objectrequired

アクセスレベルオブジェクトの配列。顧客がアクセスレベルを持たない場合は空配列

access_level_idstring

アクセスレベルの識別子

storestring

アクセスレベルが購入されたストア

store_product_idstring

ストアにおけるプロダクト ID

store_base_plan_idstring

ストアにおけるベースプラン ID

store_transaction_idstring

ストアにおけるトランザクション ID

store_original_transaction_idstring

ストアにおける元のトランザクション ID

offerallOf

プロモーションオファーまたは初回オファーが適用された場合のオファー詳細

categorystring

オファーのカテゴリ

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

オファーの種別

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

オファー ID

starts_atstring

アクセスレベルの開始日時

purchased_atstring

アクセスレベルが購入された日時

originally_purchased_atstring

アクセスレベルが最初に購入された日時

expires_atstring

アクセスレベルの有効期限

renewal_cancelled_atstring

更新がキャンセルされた日時

billing_issue_detected_atstring

請求問題が検出された日時

is_in_grace_periodboolean

アクセスレベルがグレース期間中かどうか

cancellation_reasonstring

キャンセルの理由

subscriptionsarray of objectrequired

サブスクリプションオブジェクトの配列。顧客がサブスクリプションを持たない場合は空配列

storestring

サブスクリプションが購入されたストア

store_product_idstring

ストアにおけるプロダクト ID

store_base_plan_idstring

ストアにおけるベースプラン ID

store_transaction_idstring

ストアにおけるトランザクション ID

store_original_transaction_idstring

ストアにおける元のトランザクション ID

offerallOf

プロモーションオファーまたは初回オファーが適用された場合のオファー詳細

categorystring

オファーのカテゴリ

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

オファーの種別

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

オファー ID

environmentstring

環境（サンドボックス、本番）

purchased_atstring

サブスクリプションが購入された日時

originally_purchased_atstring

サブスクリプションが最初に購入された日時

expires_atstring

サブスクリプションの有効期限

renewal_cancelled_atstring

更新がキャンセルされた日時

billing_issue_detected_atstring

請求問題が検出された日時

is_in_grace_periodboolean

サブスクリプションがグレース期間中かどうか

cancellation_reasonstring

キャンセルの理由

non_subscriptionsarray of objectrequired

非サブスクリプションオブジェクトの配列。顧客が購入履歴を持たない場合は空配列

purchase_idstring

購入の一意の識別子

storestring

購入が行われたストア

store_product_idstring

ストアにおけるプロダクト ID

store_base_plan_idstring

ストアにおけるベースプラン ID

store_transaction_idstring

ストアにおけるトランザクション ID

store_original_transaction_idstring

ストアにおける元のトランザクション ID

purchased_atstring

購入が行われた日時

environmentstring

環境（サンドボックス、本番）

is_refundboolean

返金かどうか

is_consumableboolean

消耗型アイテムの購入かどうか

リクエストが不正です

Schema

errorsarray of objectrequired

sourcestring

エラーの発生源

errorsarray of string

エラーメッセージの配列

error_codestringrequired

エラーの短縮名

status_codeintegerrequired

HTTP ステータスコード

認証エラー

Schema

errorsarray of objectrequired

sourcestring

エラーの発生源

errorsarray of string

エラーメッセージの配列

error_codestringrequired

エラーの短縮名

status_codeintegerrequired

HTTP ステータスコード

プロファイルが見つかりません

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/set/transaction/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "purchase_type": "one_time_purchase",
    "store": "app_store",
    "environment": "Production",
    "store_product_id": "premium_lifetime",
    "store_transaction_id": "1000000123456789",
    "store_original_transaction_id": "1000000123456789",
    "is_family_shared": false,
    "price": {
      "country": "US",
      "currency": "USD",
      "value": 9.99
    },
    "purchased_at": "2024-01-15T10:30:00Z",
    "variation_id": "variation_123",
    "offer": null,
    "refunded_at": null,
    "cancellation_reason": null
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/set/transaction/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "purchase_type": "one_time_purchase",
    "store": "app_store",
    "environment": "Production",
    "store_product_id": "premium_lifetime",
    "store_transaction_id": "1000000123456789",
    "store_original_transaction_id": "1000000123456789",
    "is_family_shared": false,
    "price": {
      "country": "US",
      "currency": "USD",
      "value": 9.99
    },
    "purchased_at": "2024-01-15T10:30:00Z",
    "variation_id": "variation_123",
    "offer": null,
    "refunded_at": null,
    "cancellation_reason": null
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/purchase/set/transaction/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "purchase_type": "one_time_purchase",
      "store": "app_store",
      "environment": "Production",
      "store_product_id": "premium_lifetime",
      "store_transaction_id": "1000000123456789",
      "store_original_transaction_id": "1000000123456789",
      "is_family_shared": False,
      "price": {
        "country": "US",
        "currency": "USD",
        "value": 9.99
      },
      "purchased_at": "2024-01-15T10:30:00Z",
      "variation_id": "variation_123",
      "offer": None,
      "refunded_at": None,
      "cancellation_reason": None
    })
data = response.json()