コンテンツへスキップ
/
プロモーションの削除

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

操作

決済

操作

プロモーション

操作

プロモーションの作成

リクエスト

新しいプロモーションを作成します。

通知

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

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

マーチャントID。

ボディapplication/json必須
descriptionobject

ローカライズされたプロモーション記述の配列。

labelobject

決済インターフェースに表示するローカライズされたラベルの配列。

nameobject

ローカライズされたプロモーション名の配列。

project_idinteger必須

プロジェクトID。

technical_namestring必須

プロモーションの名称。

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Promotion with 30% discount",
      "ru": "Акция со скидкой 30%"
    },
    "label": {
      "en": "30%",
      "ru": "30%"
    },
    "name": {
      "en": "30% discount",
      "ru": "скидка 30%"
    },
    "project_id": 12345,
    "technical_name": "Sale promotion"
  }'

レスポンス

Created (作成済み)。

ボディapplication/json
idinteger

プロモーションID。

レスポンス
application/json
{
  "id": 17890
}

プロモーションの削除

リクエスト

プロモーションを削除します。enabled = false のプロモーションのみ削除できます。

通知

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

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

マーチャントID。

promotion_idinteger必須

プロモーションID。

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

レスポンス

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

プロモーションの取得

リクエスト

プロモーションを取得します。

通知

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

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

マーチャントID。

promotion_idinteger必須

プロモーションID。

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

レスポンス

OK。

ボディapplication/json
descriptionobject

ローカライズされたプロモーション記述の配列。

labelobject

決済インターフェースに表示するローカライズされたラベルの配列。

nameobject

ローカライズされたプロモーション名の配列。

project_idinteger

プロジェクトID。

technical_namestring

プロモーションの名称。

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
レスポンス
application/json
{
  "description": {
    "en": "Promotion with 30% discount",
    "ru": "Акция со скидкой 30%"
  },
  "enabled": false,
  "id": 17890,
  "label": {
    "en": "30%",
    "ru": "30%"
  },
  "name": {
    "en": "30% discount",
    "ru": "Скидка 30%"
  },
  "project_id": 40544,
  "read_only": false,
  "show_banner": true,
  "technical_name": "Sale promotion"
}

クーポン

操作

Subscription management

操作