コンテンツへスキップ
/
List plans

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/

トークン

操作

プラン

操作

製品

操作

サブスクリプション

操作

決済

操作

プロモーション

操作

クーポン

操作

サブスクリプション

操作

Catalog

操作

Get catalog

リクエスト

セキュリティ
projectUserJwtAuth
パス
project_idinteger\d+必須
クエリ
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/api/user/v1/projects/{project_id}/catalog?limit=0&offset=0&locale=string&country=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

Subscription's catalog

ボディapplication/json
default_plansobject必須
default_plans.​has_moreboolean必須
例: "false"
default_plans.​itemsArray of objects
デフォルト []
default_plans.​items[].​chargeobject必須
default_plans.​items[].​charge.​amountnumber(float)必須
例: 4.99
default_plans.​items[].​charge.​currencystring必須
例: "USD"
default_plans.​items[].​charge.​setup_feenumber(float)必須
例: 0.99
default_plans.​items[].​periodobject必須
default_plans.​items[].​period.​unitstring or null
デフォルト null
例: "month"
default_plans.​items[].​period.​valueinteger or null
デフォルト null
例: "1"
default_plans.​items[].​plan_descriptionstring必須
例: "Localized plan description"
default_plans.​items[].​plan_end_datestring or null(date-time)
例: "2031-04-11T13:51:02+03:00"
default_plans.​items[].​plan_external_idstring必須
例: "PlanExternalId"
default_plans.​items[].​plan_group_idstring or null
例: "TestGroupId"
default_plans.​items[].​plan_idinteger必須
例: "54321"
default_plans.​items[].​plan_namestring必須
例: "Localized plan name"
default_plans.​items[].​plan_start_datestring or null(date-time)
例: "2021-04-11T13:51:02+03:00"
default_plans.​items[].​plan_typestring必須
例: "all"
default_plans.​items[].​promotionobject必須
default_plans.​items[].​promotion.​promotion_charge_amountnumber or null(float)
デフォルト null
例: "3.99"
default_plans.​items[].​promotion.​promotion_remaining_chargesinteger or null
デフォルト null
例: "3"
default_plans.​items[].​trial_periodinteger or null
例: "7"
default_plans.​namestring or null
例: "Some product name"
has_moreboolean必須
例: "false"
plans_by_productArray of objects
デフォルト []
plans_by_product[].​has_moreboolean必須
例: "false"
plans_by_product[].​itemsArray of objects
デフォルト []
plans_by_product[].​items[].​chargeobject必須
plans_by_product[].​items[].​charge.​amountnumber(float)必須
例: 4.99
plans_by_product[].​items[].​charge.​currencystring必須
例: "USD"
plans_by_product[].​items[].​charge.​setup_feenumber(float)必須
例: 0.99
plans_by_product[].​items[].​periodobject必須
plans_by_product[].​items[].​period.​unitstring or null
デフォルト null
例: "month"
plans_by_product[].​items[].​period.​valueinteger or null
デフォルト null
例: "1"
plans_by_product[].​items[].​plan_descriptionstring必須
例: "Localized plan description"
plans_by_product[].​items[].​plan_end_datestring or null(date-time)
例: "2031-04-11T13:51:02+03:00"
plans_by_product[].​items[].​plan_external_idstring必須
例: "PlanExternalId"
plans_by_product[].​items[].​plan_group_idstring or null
例: "TestGroupId"
plans_by_product[].​items[].​plan_idinteger必須
例: "54321"
plans_by_product[].​items[].​plan_namestring必須
例: "Localized plan name"
plans_by_product[].​items[].​plan_start_datestring or null(date-time)
例: "2021-04-11T13:51:02+03:00"
plans_by_product[].​items[].​plan_typestring必須
例: "all"
plans_by_product[].​items[].​promotionobject必須
plans_by_product[].​items[].​promotion.​promotion_charge_amountnumber or null(float)
デフォルト null
例: "3.99"
plans_by_product[].​items[].​promotion.​promotion_remaining_chargesinteger or null
デフォルト null
例: "3"
plans_by_product[].​items[].​trial_periodinteger or null
例: "7"
plans_by_product[].​namestring or null
例: "Some product name"
レスポンス
application/json
{
  "default_plans": {
    "has_more": "false",
    "items": [],
    "name": "Some product name"
  },
  "has_more": "false",
  "plans_by_product": []
}

List plans

リクエスト

セキュリティ
projectUserJwtAuth
パス
project_idinteger\d+必須
クエリ
plan_idArray of integers
plan_external_idArray of strings
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/api/user/v1/projects/{project_id}/plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

Subscription's default plans

ボディapplication/json
has_moreboolean必須
例: "false"
itemsArray of objects
デフォルト []
items[].​chargeobject必須
items[].​charge.​amountnumber(float)必須
例: 4.99
items[].​charge.​currencystring必須
例: "USD"
items[].​charge.​setup_feenumber(float)必須
例: 0.99
items[].​periodobject必須
items[].​period.​unitstring or null
デフォルト null
例: "month"
items[].​period.​valueinteger or null
デフォルト null
例: "1"
items[].​plan_descriptionstring必須
例: "Localized plan description"
items[].​plan_end_datestring or null(date-time)
例: "2031-04-11T13:51:02+03:00"
items[].​plan_external_idstring必須
例: "PlanExternalId"
items[].​plan_group_idstring or null
例: "TestGroupId"
items[].​plan_idinteger必須
例: "54321"
items[].​plan_namestring必須
例: "Localized plan name"
items[].​plan_start_datestring or null(date-time)
例: "2021-04-11T13:51:02+03:00"
items[].​plan_typestring必須
例: "all"
items[].​promotionobject必須
items[].​promotion.​promotion_charge_amountnumber or null(float)
デフォルト null
例: "3.99"
items[].​promotion.​promotion_remaining_chargesinteger or null
デフォルト null
例: "3"
items[].​trial_periodinteger or null
例: "7"
レスポンス
application/json
{
  "has_more": "false",
  "items": []
}

List products

リクエスト

セキュリティ
projectUserJwtAuth
パス
project_idinteger\d+必須
クエリ
limitinteger
offsetinteger
localestring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ja/api/subscriptions/api/user/v1/projects/{project_id}/products?limit=0&offset=0&locale=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

レスポンス

Subscription's products

ボディapplication/json
has_moreboolean必須
例: false
itemsArray of objects
デフォルト []
items[].​product_descriptionstring or null
例: "Localized product description"
items[].​product_external_idstring or null
例: "ProductExternalId"
items[].​product_group_idstring or null
例: "TestGroupId"
items[].​product_idinteger必須
例: "12345"
items[].​product_namestring必須
例: "Product name"
レスポンス
application/json
{
  "has_more": false,
  "items": []
}

クーポン

操作

サブスクリプション

操作

Payment accounts

操作