ユーザーがサブスクリプションプランの変更を許可する方法

どのように動作するか

• 新しいプランを選択すると、現在のサブスクリプションの未使用期間についてユーザーの残高に返金が行われます。
• 新しいサブスクリプションプランの支払いは、すべてユーザーの残高から行われます。残高が不足している場合は、プロジェクトで許可されている決済方法のいずれかによって追加で支払われます。
• プラン変更の場合、次回請求期間からプラン変更するプロジェクトであっても、入金確認後すぐに引き落とされます。

• 新しいプランの通貨が現在のプランの通貨と異なる場合、新しいプランの購入は通貨換算で行われます。

• ユーザーは、現在のプランから変更されるプランでアクティブなサブスクリプションをすでに持っています
• ユーザーが変更したいサブスクリプションがアクティブ状態でない場合
• ユーザーが変更を希望するサブスクリプションプランがライフタイムプランタイプである場合：このようなサブスクリプションプランは、指定された返金期間内にのみキャンセルすることができます

入手方法

1. アドミンページであなたのプロジェクトを開きます。
2. サイドバーのサブスクリプションをクリックし、設定セクションに移動します。
3. 「プラン変更」セクションで、「別のプランを選択する能力」のトグルを「オン」に設定します。
4. プランの変更は、デフォルトで次の期間から許可されます。今期中にプランの変更を許可するには、「今すぐ」を選択します。このオプションを選択した場合、入金確認後すぐにプランが変更されます。
5. プランを1日に複数回変更できるようにするには、「同じ日に複数回で別のプランを選択できる機能」を「オン」に設定します。
6. 決済インターフェースを開くときは、次を使用します：
   • サーバー側のトークンを作成するAPIコール
   • プロジェクトでエクソーラログインを使用する場合、決済UIを開くためのリンクを取得するクライアント側のAPIコール

サーバー側のトークンを作成するAPIコールを介して決済UIを開く

1. 以下をメソッドに渡して、決済UIを開くためのトークンを取得します：
   • purchase.subscription.operationパラメータでのchange_plan値。
   • purchase.subscription.plan_idパラメータでの新しいプランのID。
   • サブスクリプションベースの製品を使用している場合は、purchase.subscription.product_idパラメータのサブスクリプションベースの製品ID。取得するには、カスタマーサクセスマネージャーまでお問い合わせるか、csm@xsolla.comに電子メールを送信してください。
2. 以下のいずれかの方法で決済インターフェイスを開きます：
   • ペイステーション埋め込みスクリプト
   • Iframe
   • 新しいウィンドウ

クライアントサイドのAPIコールを使って、定期購入管理ページで決済UIを開く

エクソーラログインがプロジェクトで構成されている場合、クライアントサイドのAPIコールを使って、決済インターフェースを開くためのリンクを取得することができます。レスポンスで返されるリンクにより、サブスクリプション管理ページで決済UIを開くことができ、ユーザーはアクティブなサブスクリプションを選択したり、変更したりすることができます。

これを行うには、アプリケーションのクライアント側で、HTTP POSTリクエストを使用して決済インターフェイスへのリンクの受信を実装します：https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/subscriptions/manage。 リクエストにはAuthorization: Bearer <client_user_jwt>ヘッダーが含まれている必要があります。<client_user_jwt>はユーザーのJSONウェブトークン（JWT）であり、Base64 標準に従ってエンコードされた一意のBase64エンコードトークンです。トークンと取得するには：

• アプリケーションでログインとパスワードによる認証を行う場合は、Register new userおよびAuth by usernameとパスワードのAPIコールを使用してください。
• ソーシャルネットワークを介した認証を利用する場合は、Auth via social network APIコールをご利用ください。

必要に応じて、カスタマイズのための追加パラメータを渡します。

リクエストボディパラメータ：

curl -X 'POST' \
'https://subscriptions.xsolla.com/api/user/v1/projects/{project_id}/subscriptions/manage?country=RU  ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'
{
  "settings": {
    "ui": {
      "size": "large",
      "theme": "string",
      "version": "desktop",
      "desktop": {
        "header": {
          "is_visible": true,
          "visible_logo": true,
          "visible_name": true,
          "type": "compact",
          "close_button": true
        }
      },
      "mobile": {
        "mode": "saved_accounts",
        "footer": {
          "is_visible": true
        },
        "header": {
          "close_button": true
        }
      },
      "license_url": "string",
      "mode": "user_account",
      "user_account": {
        "history": {
          "enable": true,
          "order": 1
        },
        "payment_accounts": {
          "enable": true,
          "order": 1
        },
        "info": {
          "enable": true,
          "order": 1
        },
        "subscriptions": {
          "enable": true,
          "order": 1
        }
      }
    },
    "currency": "str",
    "locale": "st",
    "external_id": "string",
    "payment_method": 1,
    "return_url": "string",
    "redirect_policy": {
      "redirect_conditions": "none",
      "delay": 0,
      "status_for_manual_redirection": "none",
      "redirect_button_caption": "string"
    }
  }
}

応答の例：

{
  "link_to_ps": "https://secure.xsolla.com/paystation2/?access_token=<access_token>"
}