コンテンツへスキップ
/
決済システムの一覧

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) の場合、project_id パラメータを変更することはできません。

通知

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

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

マーチャントID。

promotion_idinteger必須

プロモーションID。

ボディapplication/json必須
descriptionobject

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

description.​arstring

アラビア語。

description.​bgstring

ブルガリア語。

description.​cnstring

中国語（簡体字）。

description.​csstring

チェコ語。

description.​destring

ドイツ語。

description.​enstring

英語。

description.​esstring

スペイン語。

description.​frstring

フランス語。

description.​hestring

ヘブライ語。

description.​itstring

イタリア語。

description.​jastring

日本語。

description.​kostring

韓国語。

description.​plstring

ポーランド語。

description.​ptstring

ポルトガル語。

description.​rostring

ルーマニア語。

description.​rustring

ロシア語。

description.​thstring

タイ語。

description.​trstring

トルコ語。

description.​twstring

中国語（繁体字）。

description.​vistring

ベトナム語。

labelobject

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

label.​arstring

アラビア語。

label.​bgstring

ブルガリア語。

label.​cnstring

中国語（簡体字）。

label.​csstring

チェコ語。

label.​destring

ドイツ語。

label.​enstring

英語。

label.​esstring

スペイン語。

label.​frstring

フランス語。

label.​hestring

ヘブライ語。

label.​itstring

イタリア語。

label.​jastring

日本語。

label.​kostring

韓国語。

label.​plstring

ポーランド語。

label.​ptstring

ポルトガル語。

label.​rostring

ルーマニア語。

label.​rustring

ロシア語。

label.​thstring

タイ語。

label.​trstring

トルコ語。

label.​twstring

中国語（繁体字）。

label.​vistring

ベトナム語。

nameobject

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

name.​arstring

アラビア語。

name.​bgstring

ブルガリア語。

name.​cnstring

中国語（簡体字）。

name.​csstring

チェコ語。

name.​destring

ドイツ語。

name.​enstring

英語。

name.​esstring

スペイン語。

name.​frstring

フランス語。

name.​hestring

ヘブライ語。

name.​itstring

イタリア語。

name.​jastring

日本語。

name.​kostring

韓国語。

name.​plstring

ポーランド語。

name.​ptstring

ポルトガル語。

name.​rostring

ルーマニア語。

name.​rustring

ロシア語。

name.​thstring

タイ語。

name.​trstring

トルコ語。

name.​twstring

中国語（繁体字）。

name.​vistring

ベトナム語。

project_idinteger必須

プロジェクトID。

technical_namestring必須

プロモーションの名称。

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

レスポンス

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}/payment_systems'

レスポンス

OK。

ボディapplication/json
idinteger
payment_systemsArray of objects

決済システム。

payment_systems[].​idinteger

決済システムID。

payment_systems[].​namestring

決済システム名。

レスポンス
application/json
{
  "id": 17840,
  "payment_systems": [
    { … }
  ]
}

決済システムの設定

リクエスト

プロモーションでサポートされる支払いシステムを設定します。リストが空の場合、プロモーションはすべての支払いシステムに適用されます。プロモーションが読み取り専用 (read_only = true) の場合、このメソッドを呼び出すことはできません。

通知

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

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

マーチャントID。

promotion_idinteger必須

プロモーションID。

ボディapplication/json必須
payment_systemsArray of objects

決済システム。

payment_systems[].​idinteger

決済システムID。

payment_systems[].​namestring

決済システム名。

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/payment_systems' \
  -H 'Content-Type: application/json' \
  -d '{
    "payment_systems": [
      {
        "id": 24,
        "name": "PayPal"
      }
    ]
  }'

レスポンス

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

クーポン

操作

Subscription management

操作