구독 목록 조회
등록된 구독 계약(OrderSubscription) 목록을 조회하는 API입니다.
고객이 구독 상품을 주문하면 구독 계약이 생성되며, 설정에 따라 주기적으로 자동 결제가 발생합니다.
GET
https://api.bootapi.com/v1/order_subscriptions
구독(OrderSubscription) 흐름
- 구독 상품 주문 요청 → 구독 계약 데이터 생성
- 설정에 따라 판매자가 구독 계약 승인 (또는 자동 승인)
- 승인 완료 후 설정된 주기에 따라 자동 결제(Bill) 생성
구독 상태 코드
0계약 대기-1무료 체험 중1구독 중-2잠시 멈춤 (사용자 요청)-3문제로 멈춤 (결제 실패)15자동 종료 (만료)20직접 해지-10첫 결제 오류-11관리자 중단1
Server
SDK 설치
서버에서 API를 호출하기 위해 Backend SDK를 설치합니다.
SDK 설치 및 설정 방법은 토큰 발급 가이드를 참고하세요.
2
Server
구독 목록 조회
조건에 맞는 구독 계약 목록을 조회합니다.
요청 파라미터
| 파라미터 | 타입 | 필수 | 설명 |
|---|---|---|---|
order_number | string | 주문 생성시 생성한 주문 번호 | |
keyword | string | 검색 키워드 (username, user_phone 등) | |
s_at | string | 검색 시작일 (YYYY-MM-DD) | |
e_at | string | 검색 종료일 (YYYY-MM-DD) | |
status | array<number> | 구독 상태 필터 | |
cancel_status | number | 취소 상태 필터 | |
user_id | string | 특정 사용자 ID로 필터 | |
page | integer | 페이지 번호 (기본값: 1) | |
limit | integer | 페이지당 데이터 수 (기본값: 20) |
3
Server
응답 처리
구독 목록과 상태별 통계를 확인합니다.
응답 데이터
| 파라미터 | 타입 | 설명 |
|---|---|---|
count | number | 조회된 데이터의 총 개수 |
sum_active | number | 구독 중인 건수 (status = 1) |
sum_pending | number | 계약 대기 상태 건수 (status = 0) |
sum_trial | number | 무료 체험 중인 건수 (status = -1) |
sum_pause | number | 일시 정지된 건수 (status = -2) |
sum_hold_on | number | 문제로 중단된 건수 (status = -3) |
sum_auto_end | number | 자동 종료된 건수 (status = 15) |
sum_terminated | number | 해지된 건수 (status = 20, -11) |
list | array<object> | 구독 계약 목록 |
