콘텐츠로 건너뛰기
/
캠페인에 쿠폰 추가

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

작업

결제

작업

프로모션

작업

쿠폰

작업

캠페인 생성

요청

새로운 쿠폰 캠페인을 생성합니다.

주의

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

보안
basicAuth
경로
merchant_idinteger필수

판매자 ID입니다.

본문application/json필수
campaign_codestring필수

Campaign name.

campaign_namesobject필수

Object containing localized campaign names.

campaign_names.​arstring

아랍어.

campaign_names.​bgstring

불가리아어.

campaign_names.​cnstring

중국어(간체).

campaign_names.​csstring

체코어.

campaign_names.​destring

독일어.

campaign_names.​enstring

영어.

campaign_names.​esstring

스페인어.

campaign_names.​frstring

프랑스어.

campaign_names.​hestring

히브리어.

campaign_names.​itstring

이탈리아어.

campaign_names.​jastring

일본어.

campaign_names.​kostring

한국어.

campaign_names.​plstring

폴란드어.

campaign_names.​ptstring

포르투갈어.

campaign_names.​rostring

루마니아어.

campaign_names.​rustring

러시아어.

campaign_names.​thstring

태국어.

campaign_names.​trstring

터키어.

campaign_names.​twstring

중국어(번체).

campaign_names.​vistring

베트남어.

campaign_redeems_count_for_userinteger

캠페인 내 사용자당 최대 쿠폰 사용 횟수입니다. null이 전달되면 사용 횟수가 무제한으로 설정됩니다.

expiration_datestring(datetime)

ISO 8601 에 따라 YYYY-MM-DD’T’HH:MM:SS 형식으로 되어 있는 캠페인 만료일입니다.

project_idinteger필수

Project ID.

redeems_countinteger

최대 쿠폰 사용 횟수입니다. null이 전달되면 사용 횟수가 무제한으로 설정됩니다.

redeems_count_for_userinteger

사용자당 최대 쿠폰 사용 횟수입니다. null이 전달되면 사용 횟수가 무제한으로 설정됩니다.

subscription_couponobject

Object containing subscription parameters in a reward.

virtual_currency_amountnumber(float)

Virtual currency amount in a reward.

virtual_itemsobject

Array of virtual items parameters in a reward.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/coupon_promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_code": "sample_campaign",
    "campaign_names": {
      "en": "Campaign Name",
      "ru": "Название кампании"
    },
    "campaign_redeems_count_for_user": 1,
    "expiration_date": "2019-12-31",
    "project_id": 12345,
    "redeems_count": 10,
    "redeems_count_for_user": 1,
    "subscription_coupon": {
      "plan_id": 123,
      "product_id": 456,
      "trial_period": 30
    },
    "virtual_currency_amount": 200
  }'

응답

생성됨.

본문application/json
idinteger
예제: 9134
응답
application/json
{
  "id": 9134
}

캠페인에 쿠폰 추가

요청

쿠폰 캠페인에 쿠폰 코드를 추가합니다.

주의

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

보안
basicAuth
경로
merchant_idinteger필수

판매자 ID입니다.

campaign_idinteger필수

Campaign ID.

본문application/json필수
coupon_codestring필수

Coupon code.

예제: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

응답

콘텐츠가 없습니다.

프로모션에 캠페인 연결

요청

특정 프로모션에 쿠폰 캠페인을 첨부합니다.

주의

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

보안
basicAuth
경로
merchant_idinteger필수

판매자 ID입니다.

promotion_idinteger필수

프로모션 ID입니다.

본문application/json필수
campaignsArray of integers필수

캠페인 ID 배열입니다.

예제: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

응답

콘텐츠가 없습니다.

Subscription management

작업