구독 내용 변경
구독 계약(OrderSubscription)의 기본 정보를 변경하는 간단한 API입니다.
상품 옵션, 수량, 구독 기간, 고객 정보 등을 즉시 수정할 수 있습니다.
PUT
https://api.bootapi.com/v1/order_subscriptions/:id
일시정지, 해지 등 상태 변경이 필요한 경우
금액 조정, 일시정지, 해지 등 추가적인 비즈니스 로직이 필요한 변경은 구독 변경 요청 기능을 사용하세요. 고객 요청 → 관리자 승인 워크플로우를 지원합니다.
관리자 권한 필요
이 API는 supervisor 권한이 필요합니다. 관리자 토큰으로 요청해주세요.
변경 가능 항목
- 상품, 옵션, 수량
- 구독명, 구독기간
- 계약자 정보, 배송지 정보
- 무료체험기간
이 API vs 구독 변경 요청
이 API (내용 변경)
관리자가 즉시 수정. 단순 정보 변경에 적합
구독 변경 요청
고객 요청 → 승인 플로우. 일시정지, 해지, 금액 조정 등
1
Server
SDK 설치
서버에서 API를 호출하기 위해 Backend SDK를 설치합니다.
SDK 설치 및 설정 방법은 토큰 발급 가이드를 참고하세요.
2
Server
구독 내용 변경
변경할 필드만 선택적으로 전달합니다.
요청 파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
id | string | 필수 | 구독 계약 고유 번호 또는 external_uid |
product_id | string | 변경할 상품 ID | |
product_option_id | string | 변경할 상품 옵션 ID | |
order_name | string | 변경할 구독명 | |
quantity | integer | 변경할 수량 | |
total_subscription_duration | integer | 변경할 총 구독 회차 | |
address_id | string | 변경할 배송지 ID | |
username | string | 변경할 사용자 이름 | |
phone | string | 변경할 전화번호 | |
email | string | 변경할 이메일 | |
use_free_trial | boolean | 무료체험 사용 여부 | |
free_trial_day | integer | 무료체험 기간(일) | |
service_start_at | string | 구독 시작일 (YYYY-MM-DD) | |
service_end_at | string | 구독 종료일 (YYYY-MM-DD) |
3
Server
응답 처리
HTTP status로 성공 여부를 확인합니다.
응답 데이터
| 파라미터 | 타입 | 설명 |
|---|---|---|
id | string | 구독 계약 고유 ID |
external_uid | string | 가맹점 지정 고유 ID (ex_uid) |
order_name | string | 변경된 구독명 |
updated_at | string | 수정 일시 |