Skip to main content
POST
/
api
/
v1
/
cover
/
price
가격 플랜 정보 등록 API
curl --request POST \
  --url https://api.steppay.kr/api/v1/cover/price \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "name": "<string>",
  "productId": 123,
  "price": 123,
  "isRecurring": true,
  "partnerPriceId": "<string>",
  "replaceIfExists": true,
  "recurringInterval": "DAY",
  "recurringIntervalCount": 123
}
'
{
  "id": 123,
  "name": "<string>",
  "partnerPriceId": "<string>",
  "product": {
    "id": 123,
    "name": "<string>",
    "partnerProductId": "<string>",
    "featuredImageUrl": "<string>"
  },
  "price": 123,
  "isRecurring": true,
  "recurringInterval": "DAY",
  "recurringIntervalCount": 123
}

Authorizations

Secret-Token
string
header
required

Body

application/json

가격 생성 데이터

name
string
required

플랜 이름

productId
integer<int64>
required

플랜과 연관된 상품 ID

price
number
required

판매 가격

isRecurring
boolean
required

정기결제인지 여부

partnerPriceId
string
required

가맹점에서 사용하는 플랜의 unique ID

replaceIfExists
boolean

partnerPriceId 이미 존재할 때 replaceIfExists가 true 이면 값을 수정하고, false 이면 exception 이 발생합니다.

recurringInterval
enum<string>

결제 주기에 대한 단위(isRecurring이 true일 때)

Available options:
DAY,
WEEK,
MONTH,
YEAR
recurringIntervalCount
integer<int32>

결제 주기에 대한 수(isRecurring이 true일 때)

Response

가격 플랜 정보가 정상적으로 등록됨

id
integer<int64>
required

플랜 ID - 다른 API 호출에 사용되므로 해당 플랜 정보와 함께 저장해놓고 사용하세요.

name
string
required

플랜 이름

partnerPriceId
string
required

가맹점에서 사용하는 플랜의 unique ID

product
상품 정보 · object
required

플랜과 연관된 상품 정보

price
number
required

판매 가격

isRecurring
boolean
required

정기결제인지 여부

recurringInterval
enum<string>

결제 주기에 대한 단위(isRecurring이 true일 때)

Available options:
DAY,
WEEK,
MONTH,
YEAR
recurringIntervalCount
integer<int32>

결제 주기에 대한 수(isRecurring이 true일 때)