subscribe.customer

빌링키 결제예약 조회 API

결제예약 복수조회(빌키) API와 동일한 동작을 하는 API입니다. customer_uid별 결제예약목록을 조회할 수 있습니다. 결제예약정보가 (페이징된)목록으로 전달되며, 최대 3개월 단위로 조회가 가능합니다. 결제예약정보가 예약된 시각 기준으로 최신순으로 정렬되어 전달됩니다.

get/subscribe/customers/{customer_uid}/schedules

Path parameters

customer_uidstring required

결제예약에 사용된 구매자의 결제 수단 식별 고유번호

Query parameters

pageinteger

조회목록 페이징. 1부터 시작하며, 기본값은 1입니다.

frominteger required

조회 시작시각 unix timestamp(결제예약건의 '예약시각'기준으로 조회합니다. from <= '예약시각')

tointeger required

조회 종료시각 unix timestamp(결제예약건의 '예약시각'기준으로 조회합니다. '예약시각' < to)

schedule-status'scheduled' | 'executed' | 'revoked'

예약상태. 누락되면 모든 상태의 예약내역 조회 <ul> <li>scheduled: 예약됨(실행되기 전)</li> <li>executed: 예약된 결제실행완료</li> <li>revoked: 예약철회</li></ul>

Response

결제예약목록 조회완료

codeinteger

0이면 정상적인 조회, 0아닌 값이면 message를 확인해봐야 합니다

messagestring

code값이 0이 아닐 때, '존재하지 않는 결제정보입니다'와 같은 오류 메세지를 포함합니다

Changes

No recorded changes to this endpoint across all 1 revision of this API.