일시 정지/재개 요청
고객이 구독을 일시적으로 정지하거나 재개하기 위해 요청하는 API입니다.
설정(SubscriptionSetting)에 따라 일시정지 가능 여부가 결정됩니다.
POST
https://api.bootapi.com/v1/order_subscriptions/requests/ing/pause
일시정지/재개 시나리오
1. 일시정지 요청
- 고객이 일시정지 시작일과 종료일을 지정하여 요청
- 설정에 따라 관리자 승인 또는 자동 처리
2. 재개 요청
- 일시정지 기간 중 또는 종료 후 재개 요청
- 회차 기준으로 구독 기간 재계산
3. 유의사항
- 회차당 일시정지 가능 횟수 제한 가능
- 구독 상태가 '진행중'일 때만 요청 가능
1
Server
SDK 설치
서버에서 API를 호출하기 위해 Backend SDK를 설치합니다.
SDK 설치 및 설정 방법은 토큰 발급 가이드를 참고하세요.
2
Server
일시정지/재개 요청
구독 계약 ID와 요청 정보를 전달하여 일시정지 또는 재개를 요청합니다.
요청 파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
order_subscription_id | string | 필수 | 구독 계약 고유 번호 (URL 파라미터) |
request_type | number | 필수 | 요청 타입 (1: 일시정지, 2: 재개) |
pause_start_at | string | 일시정지 시작일 (ISO 8601) | |
pause_end_at | string | 일시정지 종료일 (재개 예정일) | |
reason | string | 요청 사유 |
3
Server
응답 처리
요청 결과를 확인하고 필요시 승인 대기 상태를 안내합니다.
응답 데이터
| 파라미터 | 타입 | 설명 |
|---|---|---|
id | string | 구독 계약 고유 ID |
status | number | 변경된 구독 상태 |
request_type | number | 요청 타입 |
pause_start_at | string | 일시정지 시작일 |
pause_end_at | string | 일시정지 종료일 |
