Skip to main content
POST
/
api
/
v1
/
subscriptions
/
{subscriptionId}
/
cancel
구독 취소
curl --request POST \
  --url https://api.steppay.kr/api/v1/subscriptions/{subscriptionId}/cancel \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "whenToCancel": "NOW",
  "when": "2023-11-07T05:31:56Z"
}
'
{
  "message": "<string>",
  "body": {}
}

Authorizations

Secret-Token
string
header
required

Path Parameters

subscriptionId
integer<int64>
required

구독 번호

Body

application/json

취소 정보 - 취소 시점을 설정합니다.

whenToCancel
enum<string>
required

언제 취소되는지를 설정합니다. NOW일 경우 바로 취소되며, 이외에는 설정 시점이 되었을 때까지 취소 대기중 상태가 됩니다.

Available options:
NOW,
END_OF_PERIOD,
SPECIFIC_DATE_TIME
when
string<date-time>

whenToCancel 이 SPECIFIC_DATE_TIME 일 경우 필수값입니다. 취소되는 시점을 설정할 수 있으며, 시점이 되기 전까지는 취소 대기중 상태가 됩니다.

Response

정상적으로 처리됨

message
string
required

결과에 대한 메세지

body
object

관련 데이터