구독 상세 조회

특정 구독 계약(OrderSubscription)의 상세 정보를 조회하는 API입니다.

구독 상태, 결제 이력, 고객 정보 등 모든 정보를 확인할 수 있습니다.

GET

https://api.bootapi.com/v1/order_subscriptions/:order_subscription_id

Server

SDK 설치

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

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

Server

구독 상세 조회

구독 계약 ID를 URL 파라미터로 전달하여 상세 정보를 조회합니다.

파라미터order_subscription_id구독 계약 ID 또는 external_uid

Server

응답 모델

OrderSubscription

필드명

타입

설명

amount_delivery_area_cost

number

배송 지역별 비용

amount_delivery_base_fee

number

기본 배송비

amount_delivery_discount

number

배송비 할인

amount_delivery_fee

number

총 배송비

approval_at

iso8601

승인 일시

approval_reason

string

승인 사유

approval_status

string

승인 상태

approval_pending승인 대기approval_requested승인 요청됨approval_approved_auto자동 승인됨approval_approved_manual수동 승인됨approval_failed승인 거절됨approval_hold_on승인 보류됨

cancel_at

iso8601

취소 일시

created_at

iso8601

생성 일시

created_last_duration

number

생성된 마지막 회차

current_duration

number

현재 회차

delivery_option

string

배송 옵션

delivery_type

string

배송 타입

parcel택배direct직접 전달quick퀵 서비스pickup픽업

free_trial_day

number

무료 체험 일수

is_first_prepaid

boolean

1회차 선불 결제 여부

last_billing_created_at

string

마지막 청구 생성 일시

latest_failed_at

string

최근 실패 일시

latest_purchased_at

string

최근 구매 일시

membership_type

string

멤버십 타입

metadata

string

API 초기 요청시 보낸 메타데이터 ( * 커스텀 데이터 )

one_unit_price

number

구독 상품 1개 가격

one_unit_tax_free_price

number

구독 상품 1개 면세 가격

order_name

string

주문명

order_number

string

주문번호

order_subscription_id

string

구독 고유 주문 ID

origin_price

number

할인 전 구독 가격

pause_count

number

일시정지 횟수

pause_expected_resume_at

iso8601

일시정지 해제 예정 일시

pause_reason

string

일시정지 사유

pause_reject_reason

string

일시정지 거절 사유

pause_resumed_at

iso8601

일시정지 해제 일시

pause_total_days

number

총 일시정지 일수

paused_at

string

일시정지 일시

payment_last_duration

number

마지막 결제 회차

payment_next_at

iso8601

다음 결제 예정 일시

price

number

가격

product_name

string

상품명

product_option_name

string

상품 옵션명

product_option_price

number

상품 옵션 가격

product_option_tax_free_price

number

상품 옵션 면세 가격

product_option_type

number

상품 옵션 타입

quantity

number

수량

renewal_status

string

갱신 상태

service_end_at

string

서비스 종료 일시

service_start_at

string

서비스 시작 일시

setup_price

number

초기 금액 (ex. 설치비, 탁송비등 )

status

string

구독결제 상태

contract_requested_completed구독 계약 요청 완료subscribing구독 중auto_terminated구독 만료로 자동 종료됨manual_terminated구독자가 직접 해지함mid_term_transfer_approved중도양도승인됨mid_term_transfer_requested중도양도요청됨free_trial무료 체험 중temporarily_paused일시정지 중paused_due_to_issue문제 발생으로 일시정지됨first_payment_error첫 결제 오류 발생admin_cancelled관리자에 의해 구독 취소됨

status_error_changed_at

string

상태 에러 변경 일시

subscription_billing_base_day

number

구독 청구 기준일

subscription_billing_type

string

구독 청구 타입

subscription_payment_cycle_type

string

구독 결제 주기 타입

subscription_payment_date

number

구독 결제일

subscription_type

string

구독 타입

tax_free_price

number

면세 가격

term_ids

string

약관 ID 목록

total_subscription_duration

number

총 구독 회차 * 무제한 구독인 경우 0

total_subscription_label

string

총 구독 라벨

transfer_reason

string

이전 사유

transfer_reject_reason

string

이전 거절 사유

transferred_at

string

이전 일시

unit

string

통화 단위

use_delivery

boolean

배송 사용 여부

use_free_trial

boolean

무료 체험 사용 여부

use_subscription_times

boolean

구독 횟수 사용 여부

user_address

string

사용자 주소

user_business_number

string

사용자 사업자번호

user_company_name

string

사용자 회사명

user_email

string

사용자 이메일

user_phone

string

사용자 전화번호

username

string

사용자명

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

생성 일시

Product

필드명

타입

설명

product_snapshot_id

string

상품 스냅샷 ID

product_id

string

상품 고유 ID

name

string

상품명

images

array

상품 이미지 목록

type

string

상품 타입

general_products일반 상품digital_products디지털 상품service_products서비스 상품

tax_type

string

과세 타입

taxable과세tax_free면세zero_tax영세율

display_price

number

표시 가격

tax_free_price

number

면세 가격

use_discount

boolean

할인 사용 여부

discount_price

number

할인 금액

discount_price_type

string

할인 타입 (fixed_price: 고정금액, percentage: 비율)

use_subscription

boolean

구독 사용 여부

use_subscription_times

boolean

구독 횟수 제한 사용 여부

use_setup_fee

boolean

초기 비용 사용 여부

setup_fee_value

number

초기 비용 금액

setup_fee_type

string

초기 비용 타입

setup_fee_text

string

초기 비용 텍스트

status_display

boolean

노출 상태

status_sale

boolean

판매 상태

subscription_periods

array

구독 기간 옵션 목록

subscription

object

구독 설정 정보Subscription

Subscription (구독 설정)

필드명

타입

설명

subscription_setting_id

string

구독 설정 고유 ID

template_name

string

구독 템플릿명

type

string

구독 타입

regular_subscription정기 구독rental_subscription렌탈 구독installment_subscription할부 구독

status

string

구독 설정 상태

use_approval_auto

boolean

자동 승인 사용 여부

use_payment_timing_request

boolean

결제 시점 요청 사용 여부

fee_pay_type

string

결제 타입 (prepaid: 선불, postpaid: 후불)

payment_cycle_type

string

결제 주기

1week1주2week2주1month1개월2month2개월3month3개월6month6개월1year1년

use_free_trial

boolean

무료 체험 사용 여부

free_trial_day

number

무료 체험 일수

use_first_discount

boolean

첫 결제 할인 사용 여부

first_discount_type

string

첫 결제 할인 타입

first_discount_value

number

첫 결제 할인 금액

use_pause

boolean

일시정지 사용 여부

use_pause_approval

boolean

일시정지 승인 필요 여부

pause_max_count

number

최대 일시정지 횟수

pause_max_duration

number

최대 일시정지 기간 (일)

use_termination

boolean

해지 사용 여부

use_termination_approval

boolean

해지 승인 필요 여부

use_termination_fee

boolean

해지 수수료 사용 여부

termination_fee_label

string

해지 수수료 라벨

termination_fee_type

string

해지 수수료 계산 타입

termination_fee_value

number

해지 수수료 금액

use_auto_unsubscribe

boolean

자동 구독 해지 사용 여부

auto_unsubscribe_day

number

자동 해지 기준일

auto_unsubscribe_retry_count

number

자동 해지 전 재시도 횟수

use_delivery

boolean

배송 사용 여부

delivery_cycle_type

string

배송 주기

delivery_after

number

결제 후 배송 기준일

created_at

iso8601

생성 일시

updated_at

iso8601

수정 일시

User

필드명

타입

설명

user_id

string

사용자 고유 ID

name

string

사용자명 (마스킹 처리)

phone

string

전화번호 (마스킹 처리)

email

string

이메일 (마스킹 처리)

membership_type

string

회원 타입

member회원guest비회원

UserGroup

필드명

타입

설명

user_group_id

string

사용자 그룹 고유 ID

corporate_type

string

법인 타입

individual개인corporate법인

phone

string

그룹 전화번호

email

string

그룹 이메일

user_id

string

대표 사용자 ID

백엔드