# Subscriptions API # 概要 * **Version:** 2.0 * **Servers**: `https://api.xsolla.com/merchant/v2/` このAPIリファレンスでは、サブスクリプション、クーポン、およびプロモーションを管理するためのエンドポイントについて説明します。 サブスクリプションの詳細については、[製品ガイド](https://developers.xsolla.com/ja/doc/subscriptions)および[用語集](https://developers.xsolla.com/ja/doc/subscriptions/integration-guide/get-started/#general_glossary)を参照してください。 Version: 2.0 ## Security ### basicAuth Xsolla API は、基本アクセス認証を使用します。API へのすべてのリクエストには、`Authorization: Basic ` ヘッダーが含まれている必要があります。ここで、`` は、Base64 標準に従ってエンコードされた `merchant_id:api_key` ペアです。 これらのパラメーターを見つけるには、[パブリッシャー アカウント](https://publisher.xsolla.com/) にアクセスしてください。
API キーの操作の詳細については、[API リファレンス](https://developers.xsolla.com/ja/api/getting-started/#api_keys_overview) を参照してください。 Type: http Scheme: basic ### subscriptionsManagementJwtAuth Type: http Scheme: bearer ## Download OpenAPI description [Subscriptions API](https://developers.xsolla.com/_bundle/@l10n/ja/api/subscriptions/index.yaml) ## トークン ### トークンを作成する - [POST /merchants/{merchant_id}/token](https://developers.xsolla.com/ja/api/subscriptions/token/create-token.md): 任意のユーザー パラメータを使用してトークンを作成できます。トークンを取得するときにこれらのパラメータを送信し、支払いが成功した後にそれらを受け取ります。トークンには、このドキュメントで説明されているか、またはユーザーが事前に定義したパラメータのみを含めることができます。 パラメータが間違った形式で送信されたり、間違ったタイプである場合、トークンは発行されません。JSON 本文にエラーの説明を含む 422 HTTP コードが返されます。extended_message には、正確にどのパラメータが間違って送信されたかに関する情報が返されます。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ## プラン ### プランの一覧 - [GET /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/ja/api/subscriptions/plans/get-plans.md): すべてのサブスクリプションプランを一覧表示します。 ### プランの作成 - [POST /projects/{project_id}/subscriptions/plans](https://developers.xsolla.com/ja/api/subscriptions/plans/create-plan.md): サブスクリプションプランを作成します。 ### プランの無効化 - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/ja/api/subscriptions/plans/disable-plan.md): サブスクリプションプランを無効化します。 ### プランの有効化 - [PATCH /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/ja/api/subscriptions/plans/enable-plan.md): サブスクリプションプランを有効化します。 ### 更新のプラン - [PUT /projects/{project_id}/subscriptions/plans/{plan_id}](https://developers.xsolla.com/ja/api/subscriptions/plans/update-plan-parameters.md): サブスクリプションプランパラメータを更新します。 ### プランの削除 - [DELETE /projects/{project_id}/subscriptions/plans/{plan_id}/delete](https://developers.xsolla.com/ja/api/subscriptions/plans/delete-plan.md): サブスクリプションプランを削除します。 ## 製品 ### 製品の取得 - [GET /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/ja/api/subscriptions/products/get-products.md): すべてのサブスクリプション型の製品を一覧表示します。 ### 製品の作成 - [POST /projects/{project_id}/subscriptions/products](https://developers.xsolla.com/ja/api/subscriptions/products/create-product.md): サブスクリプション型の製品を作成します。 ### 製品の削除 - [DELETE /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/ja/api/subscriptions/products/delete-product.md): サブスクリプション型の製品を削除します。 ### 製品の更新 - [PUT /projects/{project_id}/subscriptions/products/{product_id}](https://developers.xsolla.com/ja/api/subscriptions/products/update-product.md): サブスクリプション型の製品を更新します。 ## Subscription management ### サブスクリプションの一覧 - [GET /merchants/{merchant_id}/subscriptions](https://developers.xsolla.com/ja/api/subscriptions/subscriptions/get-subscriptions.md): すべての定期サブスクリプションを一覧表示します。通知この API メソッドは高負荷時には使用できません。最大負荷は 1 分あたり 20 リクエストです。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### Get Subscription - [GET /projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/ja/api/subscriptions/subscriptions/get-subscription.md): IDで特定のサブスクリプションの詳細を取得。 ### サブスクリプションの更新 - [PUT /projects/{project_id}/users/{user_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/ja/api/subscriptions/subscriptions/update-subscription.md): ステータスを変更（active、canceled、またはnon_renewing）したり、次の請求日を延期することによって、サブスクリプションを更新します。 ## 決済 ### 通貨の一覧 - [GET /projects/{project_id}/subscriptions/currencies](https://developers.xsolla.com/ja/api/subscriptions/payments/get-currencies.md): サポートされているすべてのサブスクリプション通貨を一覧表示します。 ### 決済の一覧 - [GET /projects/{project_id}/subscriptions/payments](https://developers.xsolla.com/ja/api/subscriptions/payments/get-payments.md): すべてのサブスクリプションの決済を一覧表示します。 ### ユーザー決済の取得 - [GET /projects/{project_id}/users/{user_id}/subscriptions/payments](https://developers.xsolla.com/ja/api/subscriptions/payments/get-user-payments.md): 特定のユーザーが行ったすべての決済を一覧表示します。 ## プロモーション ### プロモーションの一覧 - [GET /merchants/{merchant_id}/promotions](https://developers.xsolla.com/ja/api/subscriptions/promotions/get-promotions-list.md): すべてのプロモーションのリスト。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### プロモーションの作成 - [POST /merchants/{merchant_id}/promotions](https://developers.xsolla.com/ja/api/subscriptions/promotions/create-promotion.md): 新しいプロモーションを作成します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### プロモーションの削除 - [DELETE /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/ja/api/subscriptions/promotions/delete-promotion.md): プロモーションを削除します。enabled = false のプロモーションのみ削除できます。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### プロモーションの取得 - [GET /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/ja/api/subscriptions/promotions/get-promotion.md): プロモーションを取得します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### プロモーションの更新 - [PUT /merchants/{merchant_id}/promotions/{promotion_id}](https://developers.xsolla.com/ja/api/subscriptions/promotions/update-promotion.md): プロモーションを更新します。プロモーションが読み取り専用 (read_only = true) の場合、project_id パラメータを変更することはできません。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 決済システムの一覧 - [GET /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/ja/api/subscriptions/promotions/get-payment-systems.md): プロモーションでサポートされている支払いシステムを取得します。リストが空の場合、プロモーションはすべての支払いシステムに適用されます。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 決済システムの設定 - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/payment_systems](https://developers.xsolla.com/ja/api/subscriptions/promotions/set-payment-systems.md): プロモーションでサポートされる支払いシステムを設定します。リストが空の場合、プロモーションはすべての支払いシステムに適用されます。プロモーションが読み取り専用 (read_only = true) の場合、このメソッドを呼び出すことはできません。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 有効期間の一覧 - [GET /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/ja/api/subscriptions/promotions/get-validity-periods.md): プロモーションが有効な日付/時刻の範囲を取得します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 有効期間の設定 - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/periods](https://developers.xsolla.com/ja/api/subscriptions/promotions/set-validity-periods.md): プロモーションが有効な日付/時刻の範囲を設定します。プロモーションが読み取り専用 (read_only = true) の場合、既存の期間を編集することはできませんが、新しい期間を追加することはできます。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### プロモーションの見直し - [GET /merchants/{merchant_id}/promotions/{promotion_id}/review](https://developers.xsolla.com/ja/api/subscriptions/promotions/review-promotion.md): プロモーションを有効にする前に確認する必要があります。このメソッドは、エラーがある場合はそのリストを返します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 報酬の一覧 - [GET /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/ja/api/subscriptions/promotions/get-rewards.md): プロモーションに関連付けられた報酬のリストを取得します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 報酬の設定 - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/rewards](https://developers.xsolla.com/ja/api/subscriptions/promotions/set-rewards.md): プロモーションの報酬を設定します。プロモーションが読み取り専用 (read_only = true) の場合、報酬を更新することはできません。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 件名の取得 - [GET /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/ja/api/subscriptions/promotions/get-subject.md): プロモーションの主題に関する情報を取得します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### 件名の設定 - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/subject](https://developers.xsolla.com/ja/api/subscriptions/promotions/set-subject.md): プロモーションの件名を設定します。プロモーションが読み取り専用 (read_only = true) の場合、件名を更新することはできません。件名には、purchase、items、または packages のいずれかの値を指定できます。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### プロモーションの切り替え - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/toggle](https://developers.xsolla.com/ja/api/subscriptions/promotions/toggle-promotion.md): プロモーションのステータスを enabled から disabled に、またはその逆に切り替えます。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ## クーポン ### キャンペーンを作成 - [POST /merchants/{merchant_id}/coupon_promotions](https://developers.xsolla.com/ja/api/subscriptions/coupons/create-campaign.md): 新しいクーポンキャンペーンを作成します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### キャンペーンにクーポンを追加 - [POST /merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons](https://developers.xsolla.com/ja/api/subscriptions/coupons/add-coupon-to-campaign.md): クーポン キャンペーンにクーポン コードを追加します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### プロモーションにキャンペーンを追加 - [PUT /merchants/{merchant_id}/promotions/{promotion_id}/coupons](https://developers.xsolla.com/ja/api/subscriptions/coupons/attach-campaign-to-promotion.md): 特定のプロモーションにクーポン キャンペーンを添付します。 通知APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。 ### クーポンの取得 - [GET /projects/{project_id}/coupons/{code}/details](https://developers.xsolla.com/ja/api/subscriptions/coupons/get-coupon.md): クーポンの詳細をコードで入手してください。 ### クーポンの償還 - [POST /projects/{project_id}/coupons/{code}/redeem](https://developers.xsolla.com/ja/api/subscriptions/coupons/redeem-coupon.md): クーポンをコードで償還してください。 ## Subscription management ### List subscriptions - [GET /api/user/v1/management/projects/{project_id}/subscriptions](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/list-subscriptions.md) ### Get management settings - [GET /api/user/v1/management/projects/{project_id}/subscriptions/settings](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/get-management-settings.md) ### Get subscription - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/get-management-subscription.md) ### Activate subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/activate](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/activate-subscription.md) ### Cancel subscription - [PUT /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/cancel](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/cancel-subscription.md) ### Get change plan link - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/change_plan](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/get-change-plan-link.md) ### Get payment account - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/get-payment-account.md) ### Manage payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_account/manage](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/manage-payment-account.md) ### List payment accounts - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/list-payment-accounts.md) ### Link payment account - [POST /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/link-payment-account.md) ### Unlink payment account - [DELETE /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/payment_accounts/{payment_account_id}](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/unlink-payment-account.md) ### List plans for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/list-plans-for-change.md) ### Get plan for change - [GET /api/user/v1/management/projects/{project_id}/subscriptions/{subscription_id}/plans_for_change/{plan_id}](https://developers.xsolla.com/ja/api/subscriptions/subscription-management/get-plan-for-change.md)