コンテンツへスキップ
/
プロモーションの切り替え

Subscriptions API (2.0)

概要

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

このAPIリファレンスでは、サブスクリプション、クーポン、およびプロモーションを管理するためのエンドポイントについて説明します。 サブスクリプションの詳細については、製品ガイドおよび用語集を参照してください。

OpenAPI記述をダウンロード
index.json
index.yaml
言語
サーバー
Mock server
https://xsolla.redocly.app/_mock/ja/api/subscriptions/

トークン

操作

プラン

操作

製品

操作

Subscription management

操作

決済

操作

プロモーション

操作

件名の設定

リクエスト

プロモーションの件名を設定します。プロモーションが読み取り専用 (read_only = true) の場合、件名を更新することはできません。件名には、purchase、items、または packages のいずれかの値を指定できます。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

セキュリティ
basicAuth
パス
merchant_idinteger必須

マーチャントID。

promotion_idinteger必須

プロモーションID。

ボディapplication/json必須
digital_contentsobject or null
itemsArray of objects

プロモーションに適用される仮想アイテムの配列。

packagesArray of objects or null

プロモーションに適用される仮想通貨パッケージの配列。

purchaseboolean

プロモーションが購入全体に適用されるかどうかを示します。

subscriptionsobject or null

プロモーションに適用されるサブスクリプションプランまたは製品。

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/subject' \
  -H 'Content-Type: application/json' \
  -d '{
    "digital_contents": null,
    "items": [
      {
        "sku": "1234"
      }
    ],
    "packages": null,
    "purchase": false,
    "subscriptions": null
  }'

レスポンス

No Content (コンテンツなし) 。

プロモーションの切り替え

リクエスト

プロモーションのステータスを enabled から disabled に、またはその逆に切り替えます。

通知

APIコールにproject_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

セキュリティ
basicAuth
パス
merchant_idinteger必須

マーチャントID。

promotion_idinteger必須

プロモーションID。

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/toggle'

レスポンス

No Content (コンテンツなし) 。

クーポン

操作

Subscription management

操作