할인 API
구독에 붙여 인보이스 금액을 깎는 할인에 관한 API 입니다.
타입 정의
API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
ArchiveSubscriptionDiscountError: | | | ...
ArchiveSubscriptionDiscountResponse: { discount }
구독 할인 보관 성공 응답
CreateSubscriptionDiscountBody: { storeId, id, name, ... }
구독 할인 생성 입력 정보
CreateSubscriptionDiscountError: | | | ...
CreateSubscriptionDiscountResponse: { discount }
구독 할인 생성 성공 응답
Currency: "KRW" | "USD" | "JPY" | ...
통화
ForbiddenError: { type, message }
요청이 거절된 경우
GetSubscriptionDiscountError: | | | ...
GetSubscriptionDiscountResponse: { discount }
구독 할인 조회 성공 응답
GetSubscriptionDiscountsBody: { storeId, page, archived }
구독 할인 다건 조회 입력 정보
GetSubscriptionDiscountsError: | |
GetSubscriptionDiscountsResponse: { items, page }
구독 할인 다건 조회 성공 응답
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우
허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.
PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
SubscriptionDiscount: { id, name, type, ... }
구독 할인
얼마를 깎는지만 정합니다. 무엇에 몇 회차 적용할지는 구독에 붙일 때 정합니다.
SubscriptionDiscountAlreadyExistsError: { type, message }
같은 아이디의 구독 할인이 이미 존재하는 경우
SubscriptionDiscountNotFoundError: { type, message }
요청된 구독 할인이 존재하지 않는 경우
SubscriptionDiscountType: "PERCENT" | "AMOUNT"
구독 할인 유형
UnarchiveSubscriptionDiscountError: | | | ...
UnarchiveSubscriptionDiscountResponse: { discount }
구독 할인 보관 해제 성공 응답
UpdateSubscriptionDiscountBody: { storeId, name }
구독 할인 수정 입력 정보
UpdateSubscriptionDiscountError: | | | ...
UpdateSubscriptionDiscountResponse: { discount }
구독 할인 수정 성공 응답