회차 목록

구독 계약에 따라 자동 생성되는 결제 회차 목록을 조회하는 API입니다.

회차는 결제 예정일 1~2일 전에 자동 생성됩니다.

GET

https://api.bootapi.com/v1/order_subscription_bills

회차(Bill) 개념

구독 주기(매주, 매월 등)에 따라 자동 생성
구독 계약의 설정 가격 기준으로 금액 결정
필요시 금액 조정(Adjustment) 가능

ℹ️

회차 상태 코드

-1결제 실패

1결제 완료

2결제 대기중

-2회차 취소됨

5결제 지연

6결제 실패 후 재시도 대기

10관리자 취소

20해지로 인한 취소

Server

SDK 설치

서버에서 API를 호출하기 위해 Backend SDK를 설치합니다.

SDK 설치 및 설정 방법은 토큰 발급 가이드를 참고하세요.

Server

회차 목록 조회

구독 계약 ID로 해당 계약의 회차 목록을 조회합니다.

요청 파라미터

파라미터	타입	설명
`order_subscription_id`	string	구독 계약 고유 번호 (없으면 전체 조회)
`status`	array<number>	회차 상태 필터 (-1: 결제실패, 1: 결제완료, 2: 대기중 등)
`keyword`	string	검색 키워드 (invoice_id 검색)
`page`	number	페이지 번호
`limit`	number	페이지당 데이터 수

Server

응답 모델

응답은 list 배열과 count로 구성됩니다.

응답 데이터

파라미터	타입	설명
`list`	array	회차 목록 배열 (OrderSubscriptionBill[])
`count`	number	전체 회차 수

OrderSubscriptionBill

필드명

타입

설명

order_subscription_bill_id

string

청구서 고유 ID

user_id

string

사용자 고유 ID

duration

number

회차 (몇 번째 청구인지)

price

number

청구 금액 (조정금액 포함)

tax_free_price

number

면세 금액

origin_price

number

원래 청구 금액

origin_tax_free_price

number

원래 면세 금액

order_name

string

주문명

membership_type

string

멤버십 타입

reserve_payment_at

iso8601

결제 예정 일시

service_start_at

iso8601

서비스 시작 일시

service_end_at

iso8601

서비스 종료 일시

status

string

청구 상태

bill_ready청구 대기bill_paid결제 완료bill_failed결제 실패bill_cancelled청구 취소bill_refunded환불 완료

unit

string

통화 단위

quantity

number

수량

retry_count

number

재시도 횟수

total_retry_count

number

총 재시도 횟수

cancelled_price

number

취소된 금액

cancelled_tax_free_price

number

취소된 면세 금액

cancelled_quantity

number

취소된 수량

one_unit_price

number

1개당 가격

one_unit_tax_free_price

number

1개당 면세 가격

use_delivery

boolean

배송 사용 여부

amount_delivery_fee

number

배송비

order_subscription_adjustments

array

해당 회차 조정금액 목록OrderSubscriptionAdjustment

products

array

상품 정보 목록

order_subscription_transaction

object

결제 트랜잭션 정보

OrderSubscriptionAdjustment

필드명

타입

설명

order_subscription_adjustment_id

string

조정금액 고유 ID

price

number

조정 금액

tax_free_price

number

면세 조정 금액

name

string

조정 항목명

type

number

조정 타입

0추가금액1할인금액

duration

number

적용 회차

created_at

iso8601

생성 일시

백엔드