はじめに
統合フロー
サブスクリプションを統合するには：
仕組み
サブスクリプションの購入
%%{init: {'themeVariables': { 'noteBkgColor': 'transparent', 'noteBorderColor': 'transparent' }}}%%
sequenceDiagram
participant U as ユーザー
participant BE as アプリケーション
participant X as エクソーラ
U->>BE: ログインする
activate BE
BE->>X: サブスクリプションプランリストをリクエストする
activate X
X-->>BE: プランリストを返す
deactivate X
BE-->>U: プロモーションを適用したパーソナライズカタログを表示する
deactivate BE
U->>BE: プランを選択する
activate BE
BE->>X: ユーザーID、プランID、およびオプションの製品IDを送信する
activate X
X-->>BE: 購入トークンを送信する
deactivate X
BE-->>U: 購入リンクを返す
deactivate BE
U->>X: 決済UIを開く
activate X
activate X
note right of X: ユーザー検証をリクエストする
deactivate X
X->>BE: ユーザー検証ウェブフックを送信する
activate BE
BE-->>X: 成功レスポンスを返す
deactivate BE
X-->>U: 支払いデータの入力を許可する
deactivate X
U->>X: 支払いデータを安全に転送する
activate X
X->>BE: 決済ウェブフックを送信する
activate BE
BE-->>X: 成功レスポンスを返す
deactivate BE
X-->>U: 購入完了画面を表示する
X->>BE: サブスクリプション作成ウェブフックを送信する
activate BE
BE-->>X: 成功レスポンスを返す
deactivate BE
X-->>U: サブスクリプション作成メールと領収書を送信する
deactivate X
継続的なサブスクリプションの自動更新
%%{init: {'themeVariables': { 'noteBkgColor': 'transparent', 'noteBorderColor': 'transparent' }}}%%
sequenceDiagram
participant U as ユーザー
participant BE as アプリケーション
participant X as Xsolla
activate X
note right of X: サブスクリプションの更新
deactivate X
X->>BE: ユーザー検証ウェブフックを送信する
activate BE
activate X
BE-->>X: 成功レスポンスを返す
deactivate BE
X-->>U: 保存された決済アカウントから資金を請求する
activate U
U->>X: 請求を確認する
deactivate U
deactivate X
X->>BE: 決済ウェブフックを送信する
activate X
activate BE
BE-->>X: 成功レスポンスを返す
deactivate BE
X->>BE: サブスクリプション更新ウェブフックを送信する
activate BE
BE-->>X: 成功レスポンスを返す
deactivate BE
X-->>U: サブスクリプション更新メールと領収書を送信する
deactivate X
ユーザーフロー
flowchart LR
A[サブスクリプションプラン] --> B[チェックアウト] --> C[サブスクリプションステータス] --> D[購入メール] --> E[サブスクリプションの自動更新]
用語集
サブスクリプションプラン
ユーザーがサービスにアクセスするための請求条件（請求金額、通貨、頻度）。プランの設定は、必須の統合ステップです。
サブスクリプションベースの製品
ユーザーがサブスクリプションを購入したときに提供されるサービスまたはサービスのセット。製品の作成APIコールは、製品の作成に使用されます。サービスごとに個別のサブスクリプションの販売を設定する場合や、ユーザーが同時に複数のサブスクリプションを取得できるようにする場合は、製品の作成が必要です。サブスクリプションベースの製品には、ストリーマーのチャンネル、ゲーム、またはユニークアイテム/ユニークアビリティへのアクセスなどがあります。サブスクリプションベースの製品の設定と使用について詳しくは、こちらの説明をご覧ください。
flowchart TD
subgraph G1[Group 1]
direction LR
P1[Plan 1] ~~~ P2[Plan 2] ~~~ P3[Plan 3]
end
G1 --> PR1[Product 1]
style G1 fill:#F3F3F1,stroke:#B0B0B0
flowchart TD
subgraph G2[Group 2]
direction LR
P4[Plan 4] ~~~ P5[Plan 5]
end
G2 --> PR2[Product 2]
G2 --> PR3[Product 3]
style G2 fill:#F3F3F1,stroke:#B0B0B0
サブスクリプション
製品と選択されたプランの組み合わせです。サブスクリプションは、ユーザーがサブスクリプションプランを選択し、サービスへのアクセスを取得すると作成されます。ユーザーが同時に取得できるサブスクリプションの数は、プロジェクト内の製品の数に依存します。サブスクリプションの条件（請求期間、コスト、その他）は、選択されたプランの条件に対応します。既存のサブスクリプションの条件は、サブスクリプションの作成後にプランの条件が変更されても変更されません。
例1
製品：ゲームへのアクセス
- サブスクリプションプラン
Silver ：1ヶ月あたり10ドル - サブスクリプションプラン
Gold ：1年あたり100ドル
ユーザーは次のサブスクリプションのいずれかを選択できます：
- サブスクリプション1：月額10ドルプランのゲームへアクセスする
- サブスクリプション2：年間100ドルプランでのゲームへアクセスする
例2
製品1：ゲーム1へアクセスする
製品2：ゲーム2へのアクセス
- サブスクリプションプラン：1か月あたり10ドル
ユーザーは2つのサブスクリプションを同時に取得できます：
- サブスクリプション1：月額10ドルプランでgame1にアクセスする
- サブスクリプション2：月額10ドルプランでgame2にアクセスする
注意
サブスクリプションベースの製品がセットアップされていない場合、ユーザーは一度に1つのサブスクリプションしか取得できません。複数のサブスクリプションを同時に取得するには、あなたが製品をセットアップする必要があります。
プランのグループ
同じgroup_idパラメータ値を持つプランのセット。
グループを作成または変更するには、group_idパラメータを以下のAPIコールに渡します：
以下の場合は、プランのグループを作成する必要があります：
サブスクリプションベースの製品を作成する
製品サブスクリプションとして選択できるプランの数を制限する
ユーザーがグループ内の別のプランに切り替えられるようにする
グループの設定と使用について詳しくは、こちらの説明をご覧ください。
試行期間
ユーザーがサブスクリプションの料金を支払わずに試用できる期間です。
機能：
- 試用期間付きのサブスクリプションを購入すると、請求アカウントが作成され、認証決済が行われます。ユーザーのアカウントから少額が請求され、その後、返金されます。決済が発生しても、ウェブフックURLに決済ウェブフックは送信されません。
- 試用期間終了後、サブスクリプションプランの全費用が請求され、決済および更新されたサブスクリプションウェブフックがウェブフックURLに送信されます。サブスクリプションの決済に失敗した場合は、キャンセルされたサブスクリプションウェブフックが送信されます。試用期間はプランの有効期間には含まれず、その期間は別途計算されます。
- キャンペーンの報酬として試用期間を設けることができます。
猶予期間
支払い猶予期間。この期間中、期限までにサブスクリプション料金を支払わなかったユーザーは、引き続きサービスを使用できます。特徴：
- 猶予期間は、通常プランおよび一括払いのサブスクリプションにのみ利用できます。自動支払い更新タイプのサブスクリプションは、自動的に請求されます。
- エクソーラは、猶予期間の有効化時およびその後の猶予期間の毎日に、支払いの必要性をユーザーに通知します。
- ユーザーが猶予期間中にサブスクリプションの支払いを行った場合、支払いは全支払期間に対して行われます。
- ユーザーが実際の支払いなしでパートナーのサービスにアクセスできる日数は、サブスクリプション期間の合計日数から差し引かれます。
- プラン設定の猶予期間フィールドの値が
0の場合、プランには猶予期間がありません。
再試行期間
保存された決済アカウントからのチャージが試行される期間。この期間中、ユーザーは引き続きサブスクリプションサービスを利用できます。料金の引き落としが失敗した後にアクティブ化されます。特徴：
- 再試行期間は、通常プランおよび自動支払いのサブスクリプションにのみ適用されます。
- 請求は、保存されている支払いアカウントから1日に1回行われます。
- システムは、サブスクリプションが更新されるか、ユーザーによってキャンセルされるか、課金再試行回数を超えてキャンセルされるまで課金を試みます。
- ユーザーが再試行期間の終了前にサブスクリプションを更新した場合、ユーザーが実際の支払いなしでパートナーのサービスにアクセスできる日数が、サブスクリプション期間の合計日数から差し引かれます。
- プラン設定の「請求の再試行回数」フィールドの値が
0の場合、プランには再試行期間がありません。
自動払い
保存した請求先アカウントに自動的に課金されるサブスクリプションの更新タイプです。ユーザーの操作は必要ありません。請求先アカウントが保存されていない場合、自動払いタイプのサブスクリプションはNon renewing ステータスに切り替わります。
1回払い
メールで送られてきた決済リンクを使って、ユーザーが課金する場合のサブスクリプション更新タイプ。自動払いに対応していないサブスクリプション方法をユーザーが選択した場合に使用されます。
サブスクリプションの状態
サブスクリプションのステータスは、次のいずれかです。
- 有効。プライマリステータス。サブスクリプションは、最初の決済が成功した後に作成され、有効化されます。有効なサブスクリプションでのみ追加料金が発生します。
お知らせ
APIを使用して手動でサブスクリプションを作成することはできません。これは、購入時に自動でのみ行うことができます。
- キャンセル済み。次のいずれかの理由により、サブスクリプションはキャンセルされ、即時に有効になります：
- APIメソッドまたはエクソーラパブリッシャーアカウントからステータスが変更されました。
- ユーザーによりキャンセルされました。
- 期限切れ、パラメータに有効期限が設定されている場合。
- 請求の最大試行回数を超えました。これはデフォルトでは3回です。変更するには、カスタマーサクセスマネージャーまでお問い合わせるか、[email protected]に電子メールを送信してください。
- ゲームでユーザーが見つかりません。
- ユーザーアカウントが削除されました。
注意
サブスクリプションがキャンセルされると、最終決済を返金できます。このオプションは、パートナーとユーザーの両方が使用できます。
- 更新なし。サブスクリプションの更新がキャンセルされました。サブスクリプションは、ステータスがキャンセル済みに変わる前に現在の請求サイクルが終了するまで続きます。以下のいずれかの理由により、更新をキャンセルすることができます：
- APIメソッドまたはパブリッシャーアカウントからステータスが変更されました。
- メールリンクを介してユーザーによってキャンセルされました。
- ユーザーアカウントが削除されました。
この記事は役に立ちましたか？
ご意見ありがとうございました！
あなたのメッセージを確認し、体験を向上させるために利用させていただきます。誤字脱字などのテキストエラーを見つけましたか？ テキストを選択し、Ctrl+Enterを押します。
