Subscriptions API (2.0)
リクエスト
任意のユーザー パラメータを使用してトークンを作成できます。トークンを取得するときにこれらのパラメータを送信し、支払いが成功した後にそれらを受け取ります。トークンには、このドキュメントで説明されているか、またはユーザーが事前に定義したパラメータのみを含めることができます。
パラメータが間違った形式で送信されたり、間違ったタイプである場合、トークンは発行されません。JSON 本文にエラーの説明を含む 422 HTTP コードが返されます。extended_message には、正確にどのパラメータが間違って送信されたかに関する情報が返されます。
通知
APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。
custom_parametersオブジェクトのトークンに追加のパラメーターを渡して、不正防止フィルターを設定することができます。ドロップダウンリストには推奨パラメータが表示されます。決済ステーション説明書を参照してください。
購入の詳細を含むオブジェクト。
チェックアウトの詳細（オブジェクト）。
サブスクリプションデータ（オブジェクト）。
贈られたサブスクリプションの詳細。
贈り主の名前を非表示にするかどうか。trueの場合、電子メール通知で送り主の名前は非表示にされます。デフォルトはfalseです。
ユーザーのサブスクリプションプランに適用される操作の種類。サブスクリプションプランを変更する場合は、値change_planを渡します。purchase.subscription.plan_idパラメーターに新しいプランIDを指定してください。
サブスクリプションプランの外部ID。これは、アドミンページのサブスクリプション > サブスクリプションプランセクションで確認できます。
カスタムプロジェクト設定（オブジェクト）。
決済処理をテストするには、sandboxに設定します。この場合、https://sandbox-secure.xsolla.comを使用してテスト決済インターフェースにアクセスしてください。
支払いウィジェットです。paybycashまたはgiftcardが選択できます。このパラメータが設定されている場合、ユーザーはPay by CashまたはGift Cardsウィジェットにそれぞれリダイレクトされます。
リダイレクトポリシーの設定（オブジェクト）。
決済ステーション動作はユーザーが「閉じる」ボタンや「ゲームに戻る」ボタンをクリックすることによって引き起こされます。redirect（デフォルト）とpostmessageにすることができます。redirectに設定すると、ユーザーはトークンで渡された、またはアドミンページで指定されたURLにリダイレクトされます。postmessageに設定すると、ユーザーは他のページにリダイレクトされません。「閉じる」アイコンをクリックすると、closeイベントが開始され、「ゲームに戻る」をクリックすると、returnイベントが開始されます。
ユーザーがリターンURLにリダイレクトされる決済状態。none、successful、successful_or_canсeled、またはanyのいずれかとなります。
ページを使用して決済後にユーザーをリダイレクトします。パラメーターuser_id、foreigninvoice、invoice_idとstatusは、自動的にリンクに追加されます。
インタフェース設定（オブジェクト）。
メニュー設定（オブジェクト）。
サブスクリプションプランのサブメニュー（オブジェクト）。
仮想通貨サブメニュー。
仮想アイテムサブメニュー。
サブメニューを表示するかどうかを示します。
デスクトップバージョン（オブジェクト）のインターフェース設定。
ヘッダー設定（オブジェクト）。
デスクトップ版決済ステーションに閉じるボタンを表示する設定。このボタンは決済ステーションを閉じて、settings.return_urlパラメーターで指定されたURLにユーザーをリダイレクトします。デフォルトはfalseです。
ヘッダーを表示する方法。compact（プロジェクト名とユーザーIDを隠す）またはnormal（既定）に指定できます。
trueの場合、ヘッダーにはあなたのロゴが表示されます（最初にあなたのカスタマーサクセスマネージャーに画像を提供してください）。
サブスクリプションプラン（オブジェクト）の一覧の設定。
決済インターフェースの利用可能なサブスクリプションプランの一覧上に表示されるテキスト。
trueの場合、ユーザーの現地通貨が購読プランに設定されている通貨と異なる場合、ユーザーは両方の価格を見ることができます。1つは現地通貨で、もう1つは基本通貨で表示されます。
仮想通貨（オブジェクト）の一覧の設定。
仮想アイテム（オブジェクト）の一覧の設定。
trueの場合は、価格がボタンに表示されます。falseの場合は、価格はボタンの左側に表示されます。既定ではfalseです。
テンプレートの一覧。list（既定）またはgridに指定できます。
リンクを外部リソースにリダイレクトするかどうかを無効にします。デフォルトはtrueです。外部リンクをクリックすると、external-link-openイベントがpostMessageメカニズムを介して送信されます。urlパラメータには、リダイレクト先のリンクのアドレスが渡されます。
ユーザーアカウントの決済インターフェース。user_accountのみに指定できます：ヘッダーにはユーザーアカウントのナビゲーションメニューのみが含まれています。ユーザーは商品を選択したり、決済を行うことはできません。このモードは、デスクトップ上でのみ使用できます。
決済インターフェースのサイズ。に指定できます：
決済インターフェースのテーマ。default（既定）またはdefault_darkに指定できます。
ユーザーアカウントの詳細（オブジェクト）。
履歴 サブメニュー。
私のアカウント ページ。
お客様の決済アカウント サブメニュー。
ユーザーの詳細（オブジェクト）。
ユーザーが決済UIで国を変更できるかどうか。トークンにcountry.valueが渡された場合、デフォルトではfalseとなります。
user.emailオブジェクトは、不正対策モデルの構築に不可欠な要素であり、受け入れ率の向上に貢献します。それは、エクソーラと決済システムの両方の要件です。パラメータが渡されない場合は、決済ページにメール入力の必須項目が表示されます。ユーザーは、パラメータに渡された、または決済ページで入力された電子メールに購入領収書を受け取ります。
法人情報を含むオブジェクトです。
設立国。ISO 3166-1 alpha-2に従って大文字2文字の国コードを使用します。
トラフィック属性（オブジェクト）。
- https://api.xsolla.com/merchant/v2/merchants/{merchant_id}/token
- Mock serverhttps://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/token
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/token' \
-H 'Content-Type: application/json' \
-d '{
"purchase": {
"checkout": {
"amount": 10,
"currency": "USD"
},
"subscription": {
"gift": {
"email": "recipient_email@email.com",
"recipient": "test_recipient_v1"
}
}
},
"settings": {
"currency": "USD",
"language": "en",
"project_id": 16184,
"ui": {
"components": {
"virtual_currency": {
"custom_amount": true
}
},
"desktop": {
"virtual_item_list": {
"button_with_price": true,
"layout": "list"
}
},
"size": "medium"
}
},
"user": {
"age": 19,
"country": {
"allow_modify": true,
"value": "US"
},
"email": {
"value": "john.smith@mail.com"
},
"id": {
"value": "user_2"
},
"name": {
"value": "John Smith"
}
}
}'{ "token": "eop57k1boA7nnYPtewZ6KEXJyJADEwRT" }