콘텐츠로 건너뛰기
/
쿠폰 사용

정기 결제 API (2.0)

개요

  • 버전: 2.0
  • 서버: https://api.xsolla.com/merchant/v2/

본 API 참조는 정기 결제, 쿠폰 및 프로모션 관리 엔드포인트에 관하여 기술하고 있습니다. 정기 결제에 대한 더 자세한 내용은 제품 가이드 및 용어집을 참조하십시오.

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

토큰

작업

Plans

작업

제품

작업

Subscription management

작업

결제

작업

프로모션

작업

쿠폰

작업

쿠폰 가져오기

요청

Get coupon details by its code.

보안
basicAuth
경로
project_idinteger필수

Project ID.

codestring필수

Coupon code.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/projects/{project_id}/coupons/{code}/details'

응답

OK(확인).

본문application/json
keystring

Key of the user attribute.

list_of_valuesArray of objects

enum형 값의 배열입니다.

nameobject

Localized attribute names.

skip_condition_on_nonexistent_keyboolean

키가 존재하지 않는 경우 조건을 건너뛰어야 하는지 여부입니다.

typestring

키 유형입니다.

열거형"int""string""enum""date"
visibleboolean
응답
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

쿠폰 사용

요청

쿠폰 코드로 쿠폰을 사용합니다.

보안
basicAuth
경로
project_idinteger필수

Project ID.

codestring필수

Coupon code.

본문application/json필수
user_idstring필수

User ID.

예제: "1234"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/projects/{project_id}/coupons/{code}/redeem' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "1234"
  }'

응답

OK(확인).

본문application/json
campaign_codestring
coupon_codestring
coupon_idinteger
expiration_datestring
is_activeboolean
project_idinteger
redeems_count_for_userinteger
redeems_count_remaininteger
subscription_couponstring or null
virtual_currency_amountinteger
virtual_itemsArray of strings
응답
application/json
{
  "campaign_code": "new_campaign",
  "coupon_code": "ddgf5bn4",
  "coupon_id": 89613996,
  "expiration_date": "2019-12-31T00:00:00+00:00",
  "is_active": true,
  "project_id": 12345,
  "redeems_count_for_user": 10,
  "redeems_count_remain": 20,
  "subscription_coupon": null,
  "virtual_currency_amount": 200,
  "virtual_items": []
}

Subscription management

작업