サブスクリプション情報を取得する

サブスクリプションを利用したアクティビティの情報は、以下の方法で取得できます：

• APIコールを利用して情報をリクエストする（サーバーレス統合に適用する）
• ウェブフックを利用してサブスクリプションのステータスが自動的に変更されたときに情報を取得する（サーバー統合に適用する）

APIコール経由でセットアップする

プロジェクトIDをパスパラメータprojectIdとして指定します。このパラメータは、アドミンページでプロジェクト名の隣に表示されます。

クエリのパラメータとして指定します：

• limit — ページに表示される要素数の上限（デフォルトでは15個の要素が表示されます）。
• offset — リストが生成された要素の番号（カウントは0から始まります）。
• locale — インターフェイスの言語（デフォルトでは英語）。ISO 639-1規格に準拠した値を受け入れます。

curl -X 'GET' \
  'https://subscriptions.xsolla.com/api/user/v1/projects/{projectId}/subscriptions?locale=ru&limit=5&offset=5 ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

{
  "items": [
    {
      "id": 11111111,
      "plan_id": 11111,
      "plan_external_id": "TestChangePlanBase",
      "plan_name": "package_recurrent_name_66053",
      "plan_description": "package_recurrent_description_66053",
      "product_id": null,
      "product_external_id": null,
      "product_name": null,
      "product_description": null,
      "status": "active",
      "date_create": "2021-03-11T13:50:11+03:00",
      "date_next_charge": "2031-04-11T13:51:02+03:00",
      "date_last_charge": "2021-03-11T13:51:02+03:00",
      "charge": {
        "amount": "0.2500",
        "currency": "USD"
      },
      "period": {
        "value": 1,
        "unit": "day"
      }
    }
  ],
  "has_more": true
}

ウェブフックをセットアップする

サブスクリプションソリューションでは、以下のイベントのウェブフックをサポートしています：

• サブスクリプションを支払う：
  • ユーザーの確認
  • 支払い
  • 作成されたサブスクリプション

• サブスクリプションを更新する：
  • ユーザーの確認
  • 支払い
  • 更新されたサブスクリプション
• サブスクリプションをキャンセルする：キャンセルされたサブスクリプション（アドミンページでサブスクリプションがキャンセルされたか、またはすべての有効期間の支払いがキャンセルされた）

• 返金：
  • 返金（アドミンページで支払いがキャンセルされました）
  • 更新されたサブスクリプション（支払いはキャンセルされましたが、サブスクリプションはまだアクティブです。これは、ユーザーが誤ってサブスクリプションの支払いを2回行い、最後の支払いのみをキャンセルした場合に発生する可能性があります。）
  • キャンセルされたサブスクリプション（アドミンページで支払いがキャンセルされたか、すべての有効期間にわたってすべての支払いがキャンセルされました）

1. アドミンページで、プロジェクト設定 > ウェブフックに移動します。
2. ウェブフックブロックでトグルをオンに設定します。

3. ウェブフックURLを指定します。設定を保存するをクリックします。

4. アドミンページでウェブフックをテストします。
5. サブスクリプション購入をテストします。
6. サブスクリプション更新をテストします。
7. サブスクリプションのキャンセルをテストします。

アドミンページでのウェブフックをテストする

1. アドミンページ > プロジェクト設定 > ウェブフックで、サブスクリプションタブに移動します。

2. ウェブフックをテストするには、プロジェクトの値（ユーザーID、インボイスID）を指定して、指定されたウェブフックURLへのリクエストで送信します。実際の値がない場合は、任意の値を入力することができます。次のフォームフィールドに入力します：
   • ユーザーID
   • エクソーラインボイスID
   • 数量
   • 通貨
   • プランID
   • サブスクリプション製品（任意）
   • インボイスID — 内部注文番号（任意）
   • 試用期間（ サンドボックスモードでサブスクリプション購入をテストするまたはサブスクリプション更新をテストするには、0 値を設定します。）

3. テストをクリックします。
4. テストの成功メッセージを受信したことを確認します。テストが成功した場合、サーバーは204 HTTPステータスコードを返します。失敗した場合は、サーバーから400または500 HTTPステータスコードとエラーの説明が返されます。

サブスクリプション購入をテストする

• サンドボックスモードを使用します（サブスクリプション試用期間が0日の場合）
• 実際の支払いを行い、アドミンページから返金を開始します（サブスクリプション試用期間が0日を超える場合）

サンドボックスモード

1. サンドボックスモード用のトークンを取得します。試用期間（trial_days）パラメータに0の値を渡します。
2. 決済方法のクレジットカード/デビットカードグループを選択します。
3. テスト用の銀行カード情報を入力して、残りのフィールドに任意の値を入力してください。誤った情報（カード番号、有効期限、CVV）を指定して、エラーを発生させることもできます。

4. ウェブフックをセットアップするステップで指定されたURLでユーザーの確認、支払いおよび更新されたサブスクリプションのウェブフックを受け取ります。

実際のお支払い

1. アドミンページでのウェブフックのテストを完成してサブスクリプションモジュールをアクティブ化にします。
2. ライセンス契約に署名します。

3. 実際の決済ソリューションのためのトークンを取得します。

4. 以下のリンクから決済UIを開きます：https://secure.xsolla.com/paystation4/?token=ACCESS_TOKEN、そこでACCESS_TOKEN は前のステップで得られたトークンです。
5. 決済方法のクレジットカード/デビットカードグループを選択します。
6. 有効な銀行カード情報を入力してください。

7. ウェブフックをセットアップするステップで提供されたウェブフックURLでユーザーの確認、支払いおよび更新されたサブスクリプションウェブフックを受け取ります。
8. 支払いを返金します。これを行うには、アドミンページ > サポート > 取引検索にアクセスしてください。
9. テスト取引を選択し、その他（•••）メニューボタンをクリックします。ポップアップメニューの返金をクリックします（取引のステータスは完了である必要があります）。これはキャンセルされたサブスクリプションと返金ウェブフックを送信します。

サブスクリプションの更新をテストする

1. サンドボックスモードのトークンを取得します。試用期間（trial_days）パラメータに0の値を渡します。
2. 任意の決済方法を使用してサブスクリプションの支払いを行います。
3. サンドボックスモードで支払いインターフェースを再度開きます。
4. 任意の決済方法を使用してサブスクリプションを更新するには、再度支払います。
5. ウェブフックを設定するステップで指定したウェブフックURLでユーザーの確認、支払いおよび更新されたサブスクリプションのウェブフックを取得します。

テストサブスクリプションのキャンセル

• サブスクリプションで検索する
• 最近の取引で検索する
• APIコール

サブスクリプションで検索する

1. アドミンページでサポート > 加入者に移動します。
2. キャンセルしたいサブスクリプションを探します。
3. サブスクリプションのステータスメニューを開き、以下を選択します：
   1. キャンセルと返金するはキャンセルされたサブスクリプションと返金ウェブフックを受け取ります。
   2. 返金なしでキャンセルするはキャンセルされたサブスクリプションウェブフックを受け取ります。

最近の取引で検索する

1. アドミンページで、サポート > 取引検索に移動します。
2. キャンセルされた最後の取引を検索します。
3. その他（•••）アイコンをクリックします。ポップアップメニューの返金をクリックして、キャンセルされたサブスクリプションおよび返金のウェブフックを受け取ります。

APIコールを使用する

サンドボックスモードで決済UIを開く

• アドミンページを使用する
• APIコールを使用する

アドミンページ経由

1. アドミンページでウェブフックをテストします。試用期間がないサブスクリプションをテストする場合は、試用期間フィールドに値を0に指定します。テストが成功したときの確認メッセージを受け取ると、サンドボックスのURLのヘッダーの下に、必要なトークンを含むリンクが表示されます。

2. サンドボックスURLリンクをたどります。

APIコール経由

1. "settings":{"mode":"sandbox"}パラメータをトークンを作成するメソッドに渡します。"purchase": {"subscription":{"trial_days": 0}}パラメータを渡して、試用期間のないサブスクリプションをテストします。
2. 以下のリンクを使用します：https://sandbox-secure.xsolla.com/paystation4/?token=ACCESS_TOKEN、ここでACCESS_TOKENは前のステップで取得したトークンです。