Skip to main content
POST
/
api
/
v1
/
subscriptions
/
{subscriptionId}
/
pause
구독 일시 정지
curl --request POST \
  --url https://api.steppay.kr/api/v1/subscriptions/{subscriptionId}/pause \
  --header 'Content-Type: application/json' \
  --header 'Secret-Token: <api-key>' \
  --data '
{
  "whenToResume": "NOTHING",
  "whenToPause": "IMMEDIATE",
  "until": {
    "interval": "DAY",
    "intervalCount": 123
  }
}
'
{
  "message": "<string>",
  "body": {}
}

Authorizations

Secret-Token
string
header
required

Path Parameters

subscriptionId
integer<int64>
required

구독 번호

Body

application/json

일시정지 정보 - 일시정지, 재개 시점을 설정합니다.

whenToResume
enum<string>

일시정지 후 언제 재개되는지를 설정합니다. (기본값: NOTHING)

Available options:
NOTHING,
PAUSED_UNTIL
whenToPause
enum<string>

언제 일시정지 시킬 지를 설정합니다. (기본값: IMMEDIATE)

Available options:
IMMEDIATE,
LAZY
until
기간 정보 · object

whenToResume 이 PAUSED_UNTIL 일 경우 필수값입니다. 일시정지 되기까지의 기간을 설정합니다.

Response

정상적으로 처리됨

message
string
required

결과에 대한 메세지

body
object

관련 데이터