콘텐츠로 건너뛰기
/
요금제 업데이트

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

작업

요금제 활성화

요청

Enables a subscription plan.

보안
basicAuth
경로
project_idinteger필수

Project ID.

plan_idinteger필수

요금제 ID입니다.

curl -i -X PATCH \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}'

응답

콘텐츠가 없습니다.

요금제 업데이트

요청

Updates subscription plan parameters.

보안
basicAuth
경로
project_idinteger필수

Project ID.

plan_idinteger필수

요금제 ID입니다.

본문application/json필수
billing_retryobject

청구 재시도 세부 정보입니다.

chargeobject

청구 세부 정보입니다.

descriptionobject

요금제 설명입니다. "localization":"plan description" 쌍으로 구성된 값입니다.

expirationobject

정기 결제 만료 세부 정보입니다.

external_idstring

Plan external ID (32 characters).

grace_periodobject

Grace period details.

group_idstring

이러한 요금제가 연결된 그룹의 ID입니다.

nameobject

요금제 이름입니다. "localization":"plan name" 쌍으로 구성된 값입니다.

refund_periodinteger or null

사용자가 정기 결제 요금제 지급금을 환불할 수 있는 기간(일 단위)입니다.

statusobject
tagsArray of strings

Plan tags.

trialobject

무료 체험 세부 정보입니다. 이 매개 변수가 전달되지 않으면 기본값 (0일)을 사용합니다.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "billing_retry": {
      "value": 1
    },
    "charge": {
      "amount": 20,
      "currency": "USD",
      "period": {
        "type": "month",
        "value": 1
      },
      "prices": [
        {
          "amount": 17,
          "currency": "EUR",
          "setup_fee": 1.5
        },
        {
          "amount": 2000,
          "currency": "JPY",
          "setup_fee": 2.5
        }
      ]
    },
    "description": {
      "en": "3x more experience!"
    },
    "expiration": {
      "type": "day",
      "value": null
    },
    "external_id": "exp",
    "grace_period": {
      "type": "day",
      "value": 2
    },
    "name": {
      "en": "Experience boost"
    },
    "refund_period": null,
    "tags": [],
    "trial": {
      "type": "day",
      "value": 7
    }
  }'

응답

OK(확인).

본문application/json
응답
application/json
{
  "billing_retry": {
    "value": 1
  },
  "charge": {
    "amount": 20,
    "currency": "USD",
    "period": { … },
    "prices": [ … ]
  },
  "description": {
    "en": "3x more experience!"
  },
  "expiration": {
    "type": "day",
    "value": 0
  },
  "external_id": "exp",
  "grace_period": {
    "type": "day",
    "value": 2
  },
  "group_id": null,
  "id": 241082,
  "localized_name": "Experience boost",
  "name": {
    "en": "Experience boost"
  },
  "project_id": 40797,
  "refund_period": null,
  "status": {
    "value": "active"
  },
  "tags": [],
  "trial": {
    "type": "day",
    "value": 7
  },
  "type": "all"
}

요금제 삭제

요청

Deletes a subscription plan.

보안
basicAuth
경로
project_idinteger필수

Project ID.

plan_idinteger필수

요금제 ID입니다.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/subscriptions/projects/{project_id}/subscriptions/plans/{plan_id}/delete'

응답

콘텐츠가 없습니다.

제품

작업

Subscription management

작업

결제

작업

프로모션

작업

쿠폰

작업

Subscription management

작업