개발자센터

상품 API

구독 결제에 사용할 상품에 관한 API 입니다.

조건에 맞는 구독 상품 리스트를 조회합니다.

구독 결제에 사용할 상품을 생성합니다.

주어진 아이디로 구독 상품을 조회합니다.

구독 상품을 수정합니다. 입력하지 않은 필드는 기존 값을 유지하며, 보관된 상품은 수정할 수 없습니다.

구독 상품을 보관합니다. 보관된 상품은 새 구독에 담을 수 없고, 기존 구독의 청구는 유지됩니다.

구독 상품의 청구를 중지합니다. 이 상품이 담긴 구독은 해당 회차를 청구하지 않습니다.

중지된 구독 상품의 청구를 다시 시작합니다.

타입 정의

API 요청/응답의 각 필드에서 사용되는 타입 정의들을 확인할 수 있습니다
ArchiveSubscriptionProductError: ForbiddenError | InvalidRequestError | SubscriptionProductNotFoundError | ...
ArchiveSubscriptionProductResponse: { product }
구독 상품 보관 성공 응답
CreateSubscriptionProductBody: { storeId, id, name, ... }
구독 상품 생성 입력 정보
CreateSubscriptionProductError: ForbiddenError | InvalidRequestError | SubscriptionProductAlreadyExistsError | ...
CreateSubscriptionProductResponse: { product }
구독 상품 생성 성공 응답
Currency: "KRW" | "USD" | "JPY" | ...
통화
ForbiddenError: { type, message }
요청이 거절된 경우
GetSubscriptionProductError: ForbiddenError | InvalidRequestError | SubscriptionProductNotFoundError | ...
GetSubscriptionProductResponse: { product }
구독 상품 조회 성공 응답
GetSubscriptionProductsBody: { storeId, page, archived, ... }
구독 상품 다건 조회 입력 정보
GetSubscriptionProductsError: ForbiddenError | InvalidRequestError | UnauthorizedError
GetSubscriptionProductsResponse: { items, page }
구독 상품 다건 조회 성공 응답
InvalidRequestError: { type, message }
요청된 입력 정보가 유효하지 않은 경우

허가되지 않은 값, 올바르지 않은 형식의 요청 등이 모두 해당됩니다.

Map_String: { [key: string]: string }
PageInfo: { number, size, totalCount }
반환된 페이지 결과 정보
PageInput: { number, size }
다건 조회 API 에 사용되는 페이지 입력 정보
PauseSubscriptionProductBillingError: ForbiddenError | InvalidRequestError | SubscriptionProductNotFoundError | ...
PauseSubscriptionProductBillingResponse: { product }
구독 상품 청구 중지 성공 응답
ResumeSubscriptionProductBillingError: ForbiddenError | InvalidRequestError | SubscriptionProductNotFoundError | ...
ResumeSubscriptionProductBillingResponse: { product }
구독 상품 청구 재개 성공 응답
SubscriptionInterval: { unit, count }
구독 주기
SubscriptionIntervalUnit: "DAY" | "WEEK" | "MONTH" | ...
구독 주기 단위
SubscriptionProduct: { id, name, description, ... }
구독 상품
SubscriptionProductAlreadyExistsError: { type, message }
같은 아이디의 구독 상품이 이미 존재하는 경우
SubscriptionProductArchivedError: { type, message }
구독 상품이 보관되어 수정할 수 없는 경우
SubscriptionProductNotFoundError: { type, message }
요청된 구독 상품이 존재하지 않는 경우
SubscriptionProductPricingType: "RECURRING" | "ONE_TIME"
구독 상품 과금 유형
UnauthorizedError: { type, message }
인증 정보가 올바르지 않은 경우
UpdateSubscriptionProductBody: { storeId, name, description, ... }
구독 상품 수정 입력 정보
UpdateSubscriptionProductError: ForbiddenError | InvalidRequestError | SubscriptionProductArchivedError | ...
UpdateSubscriptionProductResponse: { product }
구독 상품 수정 성공 응답