콘텐츠로 건너뛰기
/
프로모션 삭제

정기 결제 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

작업

결제

작업

프로모션

작업

Create Promotion

요청

새로운 프로모션을 생성합니다.

주의

이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.

보안
basicAuth
경로
merchant_idinteger필수

판매자 ID입니다.

본문application/json필수
descriptionobject

Array of localized promotion descriptions.

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

Array of localized labels to show in the payment UI.

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

Array of localized promotion names.

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필수

Project ID.

technical_namestring필수

프로모션의 기술명입니다.

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

응답

생성됨.

본문application/json
idinteger

프로모션 ID입니다.

응답
application/json
{
  "id": 17890
}

프로모션 삭제

요청

프로모션을 삭제합니다. enabled = false인 프로모션만 삭제할 수 있습니다.

주의

이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.

보안
basicAuth
경로
merchant_idinteger필수

판매자 ID입니다.

promotion_idinteger필수

프로모션 ID입니다.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

응답

콘텐츠가 없습니다.

프로모션 대상 가져오기

요청

프로모션을 검색합니다.

주의

이 API 호출에는 project_id 경로 매개 변수가 포함되어 있지 않으므로 회사의 모든 프로젝트에서 유효한 API 키를 사용하여 인증을 설정해야 합니다.

보안
basicAuth
경로
merchant_idinteger필수

판매자 ID입니다.

promotion_idinteger필수

프로모션 ID입니다.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

응답

OK(확인).

본문application/json
descriptionobject

Array of localized promotion descriptions.

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

Array of localized labels to show in the payment UI.

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

Array of localized promotion names.

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

Project ID.

technical_namestring

프로모션의 기술명입니다.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
응답
application/json
{
  "description": {
    "en": "Promotion with 30% discount",
    "ru": "Акция со скидкой 30%"
  },
  "enabled": false,
  "id": 17890,
  "label": {
    "en": "30%",
    "ru": "30%"
  },
  "name": {
    "en": "30% discount",
    "ru": "Скидка 30%"
  },
  "project_id": 40544,
  "read_only": false,
  "show_banner": true,
  "technical_name": "Sale promotion"
}

쿠폰

작업

Subscription management

작업