コンテンツへスキップ
/
製品の作成

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/

トークン

操作

プラン

操作

製品

操作

製品の取得

リクエスト

すべてのサブスクリプション型の製品を一覧表示します。

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

プロジェクトID。

クエリ
offsetinteger

リスト生成元のエレメントの番号です（カウントは0から始まります）。

limitinteger必須

ページにあるエレメント数の制限。

group_idstring

プランがリンクされているグループのID。

product_idinteger

プランがリンクされている製品のID。

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/projects/{project_id}/subscriptions/products?offset=0&limit=0&group_id=string&product_id=0'

レスポンス

OK。

ボディapplication/jsonArray [
idinteger or null

プランがリンクされている製品のID。

descriptionobject

ローカライズされたアイテムの説明。

group_idstring

製品がリンクされているグループID。

namestring

製品名。

]
レスポンス
application/json
[
  {
    "description": { … },
    "group_id": "charge",
    "id": 714,
    "name": "Channel"
  },
  {
    "description": { … },
    "group_id": "notify",
    "id": 715,
    "name": "notify"
  },
  {
    "description": { … },
    "group_id": "charge",
    "id": 716,
    "name": "charge2"
  },
  {
    "description": { … },
    "group_id": "charge",
    "id": 486,
    "name": "Channel2"
  }
]

製品の作成

リクエスト

サブスクリプション型の製品を作成します。

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

プロジェクトID。

ボディapplication/json必須
descriptionobject

ローカライズされたアイテムの説明。

group_idstring必須

製品がリンクされているグループID。

namestring必須

製品名。

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/projects/{project_id}/subscriptions/products' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Kids TV"
    },
    "group_id": "charge",
    "name": "Channel2"
  }'

レスポンス

Created (作成済み)。

ボディapplication/json
product_idinteger
レスポンス
application/json
{
  "product_id": 172003
}

製品の削除

リクエスト

サブスクリプション型の製品を削除します。

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

プロジェクトID。

product_idinteger必須

プランがリンクされている製品のID。

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/projects/{project_id}/subscriptions/products/{product_id}'

レスポンス

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

Subscription management

操作

決済

操作

プロモーション

操作

クーポン

操作

Subscription management

操作