콘텐츠로 건너뛰기

정기 결제 API (2.0)

Overview

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

This API reference describes endpoints for managing subscriptions, coupons, and promotions. To get more information about Subscriptions, see the product guide and the glossary.

OpenAPI 설명 다운로드
index.json
index.yaml
언어
서버
Mock server
https://xsolla.redocly.app/_mock/ko/api/subscriptions/

토큰

작업

Plans

작업

제품

작업

Subscriptions

작업

결제

작업

프로모션

작업

쿠폰

작업

Subscriptions

작업

Catalog

작업

List products (no auth)

요청

경로
project_idinteger\d+필수
쿼리
limitinteger
offsetinteger
localestring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/api/public/v1/projects/{project_id}/products?limit=0&offset=0&locale=string'

응답

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": []
}

List plans by product (no auth)

요청

경로
project_idinteger\d+필수
productIdstring필수
쿼리
plan_idArray of integers
plan_external_idArray of strings
limitinteger
offsetinteger
localestring
countrystring
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/api/public/v1/projects/{project_id}/products/{productId}/user_plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string'

응답

Subscription's plans by product

본문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 plans (no auth)

요청

경로
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/ko/api/subscriptions/api/public/v1/projects/{project_id}/user_plans?plan_id=0&plan_external_id=string&limit=0&offset=0&locale=string&country=string'

응답

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": []
}

쿠폰

작업

Subscriptions

작업

Payment accounts

작업