# StepPay API

## Docs

- [고객 목록 조회](https://docs.steppay.kr/api-reference/고객-api/고객-목록-조회.md): 고객 목록을 반환합니다. Pagination 형태로 지원됩니다.
- [고객 삭제](https://docs.steppay.kr/api-reference/고객-api/고객-삭제.md): 고객 정보를 삭제할 때 호출합니다.
- [고객 상세 조회](https://docs.steppay.kr/api-reference/고객-api/고객-상세-조회.md): 고객 상세정보를 반환합니다.
- [고객 생성](https://docs.steppay.kr/api-reference/고객-api/고객-생성.md): 고객을 생성할 때 호출합니다.
- [고객 수정](https://docs.steppay.kr/api-reference/고객-api/고객-수정.md): 고객 정보를 수정할 때 호출합니다. 파라미터로 전달된 정보로 고객 정보가 치환됩니다.
- [결제수단 변경](https://docs.steppay.kr/api-reference/구독-api/결제수단-변경.md): 구독의 결제수단을 변경할 때 호출합니다. 변경을 위한 주문이 생성됩니다.
- [결제일 변경](https://docs.steppay.kr/api-reference/구독-api/결제일-변경.md): 다음 결제일을 변경합니다.
- [구독 갱신 결제](https://docs.steppay.kr/api-reference/구독-api/구독-갱신-결제.md): 다음 결제일과 상관없이 현재 시점으로 구독을 갱신시킵니다. 결제가 진행되며, 구독 시작, 끝 시점이 갱신됩니다.
- [구독 목록 조회](https://docs.steppay.kr/api-reference/구독-api/구독-목록-조회.md): 구독 목록을 반환합니다.
- [구독 상세 조회](https://docs.steppay.kr/api-reference/구독-api/구독-상세-조회.md): 구독의 상세 정보를 반환합니다.
- [구독 일시 정지](https://docs.steppay.kr/api-reference/구독-api/구독-일시-정지.md): 구독을 일시정지 합니다. 활성화 상태의 구독만 일시정지 할 수 있습니다.
- [구독 주기 변경](https://docs.steppay.kr/api-reference/구독-api/구독-주기-변경.md): 구독 주기를 변경합니다.
- [구독 취소](https://docs.steppay.kr/api-reference/구독-api/구독-취소.md): 구독을 취소합니다. 활성화, 일시정지, 결제실패 상태의 구독만 취소할 수 있습니다.
- [구독 항목 교체](https://docs.steppay.kr/api-reference/구독-api/구독-항목-교체.md): 구독 항목을 파라미터로 전달한 데이터로 교체합니다.
- [구독 항목 삭제](https://docs.steppay.kr/api-reference/구독-api/구독-항목-삭제.md): 구독 항목을 삭제할 때 호출합니다.
- [구독 항목 수정](https://docs.steppay.kr/api-reference/구독-api/구독-항목-수정.md): 특정 구독 항목을 수정할 때 사용합니다.
- [구독 항목 추가](https://docs.steppay.kr/api-reference/구독-api/구독-항목-추가.md): 구독 항목을 추가할 때 호출합니다.
- [구독 항목에서 사용할 수 있는 옵션 가져오기](https://docs.steppay.kr/api-reference/구독-api/구독-항목에서-사용할-수-있는-옵션-가져오기.md): 구독 항목에서 사용할 수 있는 옵션 목록을 반환합니다.
- [구독 활성화](https://docs.steppay.kr/api-reference/구독-api/구독-활성화.md): 구독을 다시 활성화 시킵니다. 일시정지 및 취소 대기중 상태만 변경가능합니다.
- [하위 벤더 목록 조회](https://docs.steppay.kr/api-reference/벤더-api/하위-벤더-목록-조회.md)
- [하위 벤더 상세 조회](https://docs.steppay.kr/api-reference/벤더-api/하위-벤더-상세-조회.md)
- [하위 벤더 추가](https://docs.steppay.kr/api-reference/벤더-api/하위-벤더-추가.md)
- [사용량 정산](https://docs.steppay.kr/api-reference/사용량-api/사용량-정산.md): 구독 중간에 사용량과 예상 결제 금액을 확인할 때 사용합니다.
- [사용량/계정 등록 API](https://docs.steppay.kr/api-reference/사용량-api/사용량계정-등록-api.md): 사용량 또는 계정을 등록할 때 사용합니다.
- [사용량/계정 조회 API](https://docs.steppay.kr/api-reference/사용량-api/사용량계정-조회-api.md): 사용량 또는 계정을 조회할 때 사용합니다.
- [가격 삭제](https://docs.steppay.kr/api-reference/상품-api/가격-삭제.md): 가격을 삭제할 때 호출합니다.
- [가격플랜 목록 조회](https://docs.steppay.kr/api-reference/상품-api/가격플랜-목록-조회.md): 특정 상품의 가격플랜 목록을 반환합니다.
- [가격플랜 상세 조회](https://docs.steppay.kr/api-reference/상품-api/가격플랜-상세-조회.md): 가격플랜의 상세 정보를 반환합니다.
- [가격플랜 생성](https://docs.steppay.kr/api-reference/상품-api/가격플랜-생성.md): 가격플랜을 생성할 때 호출합니다.
- [가격플랜 수정](https://docs.steppay.kr/api-reference/상품-api/가격플랜-수정.md): 가격플랜을 수정할 때 호출합니다. 파라미터로 전달된 정보로 가격플랜 정보가 치환됩니다. 연관 주문이 존재한다면 이름과 설명만 수정됩니다.
- [상품 게시 상태 변경](https://docs.steppay.kr/api-reference/상품-api/상품-게시-상태-변경.md): 상품 게시 상태를 변경할 때 호출합니다. SALE, OUT_OF_STOCK, UNSOLD 사용 가능
- [상품 목록 조회](https://docs.steppay.kr/api-reference/상품-api/상품-목록-조회.md)
- [상품 삭제](https://docs.steppay.kr/api-reference/상품-api/상품-삭제.md): 상품을 삭제할 때 호출합니다.
- [상품 상세 조회](https://docs.steppay.kr/api-reference/상품-api/상품-상세-조회.md): 상품 상세정보를 반환합니다.
- [상품 생성](https://docs.steppay.kr/api-reference/상품-api/상품-생성.md): 상품을 생성할 때 호출합니다.
- [상품 수정](https://docs.steppay.kr/api-reference/상품-api/상품-수정.md): 상품을 수정할 때 호출합니다. 파라미터로 전달된 정보로 가격플랜 정보가 치환됩니다.
- [세션 생성](https://docs.steppay.kr/api-reference/인증-api/세션-생성.md): 고객 연동을 위한 세션을 생성합니다. 세션 연동을 위한 키를 리턴합니다.
- [배송 정보 조회](https://docs.steppay.kr/api-reference/주문-api/배송-정보-조회.md): 주문의 배송 정보가 조회됩니다.
- [주문 결제링크 리다이렉트](https://docs.steppay.kr/api-reference/주문-api/주문-결제링크-리다이렉트.md): 직접 제어 하고 싶은 경우 응답에 포함된 Location 헤더를 확인하여 리다이렉트될 URI을 가져와 처리하시면 됩니다. 우측의 API 테스트 툴에서는 302 리다이렉트가 제대로 표현되지 않습니다.
- [주문 목록 조회](https://docs.steppay.kr/api-reference/주문-api/주문-목록-조회.md): 주문 목록을 반환합니다.
- [주문 상세 조회](https://docs.steppay.kr/api-reference/주문-api/주문-상세-조회.md): 주문 상세정보를 반환합니다.
- [주문 생성](https://docs.steppay.kr/api-reference/주문-api/주문-생성.md): 주문을 생성할 때 호출합니다. customerId, customCode 또는 customerUuid 중 하나는 필수로 입력해야 합니다.
- [주문 취소](https://docs.steppay.kr/api-reference/주문-api/주문-취소.md): 주문을 취소할 때 호출합니다. 결제가 완료된 주문건은 환불되며, 그렇지 않은 주문은 취소됩니다.
- [청구서 목록 조회](https://docs.steppay.kr/api-reference/청구서-api/청구서-목록-조회.md): 청구서 목록을 반환합니다.
- [청구서 삭제](https://docs.steppay.kr/api-reference/청구서-api/청구서-삭제.md): 청구서를 삭제할 때 호출합니다.
- [청구서 상세 조회](https://docs.steppay.kr/api-reference/청구서-api/청구서-상세-조회.md): 청구서의 상세정보를 반환합니다.
- [청구서 생성](https://docs.steppay.kr/api-reference/청구서-api/청구서-생성.md): 청구서를 생성할 때 호출합니다.
- [청구서 수정](https://docs.steppay.kr/api-reference/청구서-api/청구서-수정.md): 청구서를 수정할 때 호출합니다. 파라미터로 전달된 정보로 청구서가 치환됩니다.
- [idKey 알아내기 API](https://docs.steppay.kr/api-reference/커버-api/idkey-알아내기-api.md): 특정 토큰에서 결제된 idKey를 알아냅니다. 결제수단을 변경할 때 사용합니다.
- [가격 플랜 정보 등록 API](https://docs.steppay.kr/api-reference/커버-api/가격-플랜-정보-등록-api.md): 가격 플랜 정보를 스텝커버에 등록할 때 사용합니다.
- [고객 정보 등록 API](https://docs.steppay.kr/api-reference/커버-api/고객-정보-등록-api.md): 고객 정보를 스텝커버에 등록할 때 사용합니다.
- [구독 정보 등록 API](https://docs.steppay.kr/api-reference/커버-api/구독-정보-등록-api.md): 구독 정보를 스텝커버에 등록할 때 사용합니다.
- [구독 취소 API](https://docs.steppay.kr/api-reference/커버-api/구독-취소-api.md): 구독이 취소되었을 때 사용합니다. 진행중이던 시나리오가 있다면 멈춥니다.
- [구독 활성 API](https://docs.steppay.kr/api-reference/커버-api/구독-활성-api.md): 구독이 활성화 되었을 때 사용합니다. 진행중이던 시나리오가 있다면 멈춥니다.
- [복구 시작 API](https://docs.steppay.kr/api-reference/커버-api/복구-시작-api.md): 결제 복구 시나리오를 실행합니다.
- [상품 정보 등록 API](https://docs.steppay.kr/api-reference/커버-api/상품-정보-등록-api.md): 상품 정보를 스텝커버에 등록할 때 사용합니다.
- [주문 성공 API](https://docs.steppay.kr/api-reference/커버-api/주문-성공-api.md): 주문을 성공 상태로 바꿉니다. 결제 복구 시나리오가 멈춥니다.
- [주문 정보 등록 API](https://docs.steppay.kr/api-reference/커버-api/주문-정보-등록-api.md): 주문 정보를 스텝커버에 등록할 때 사용합니다.
- [주문 취소 API](https://docs.steppay.kr/api-reference/커버-api/주문-취소-api.md): 주문을 취소 상태로 바꿉니다. 결제 복구 시나리오가 멈춥니다.
- [인증 가이드](https://docs.steppay.kr/docs/01_인증.md): 스텝페이는 계정의 API Key를 사용하여 API 요청을 인증합니다. 요청에 인증키가 포함되어 있지 않거나 인증 키가 만료된 경우에는 인증 오류를 반환합니다.  API 인증키는 스텝페이 포탈에 가입된 회원에게 제공됩니다.
- [고객 가이드](https://docs.steppay.kr/docs/02_고객.md): 고객은 일반적으로 실제 결제를 수행하는 주체를 의미합니다. 이는 제품이나 서비스의 최종 사용자와 결제 주체가 다를 수 있다는 것을 의미합니다.  고객 정보에는 기본적으로 연락처, 주소, 주문 내역, 구독 내역, 마케팅 수신 동의 여부가 포함되며, [커스텀 필드](#커스텀-필드-설정-방법)를 통해 추가 정보를 저장하여 관리할 수 있습니다.
- [상품 가이드](https://docs.steppay.kr/docs/03_상품.md): 스텝페이에서 상품은 판매할 아이템과 가격 플랜을 의미합니다. 상품의 주요 속성에는 상품 유형, 상품 상태, 상품 옵션이 있으며, 상품은 가격 플랜과 밀접하게 연결이 됩니다.
- [가격 플랜 가이드](https://docs.steppay.kr/docs/04-0_가격플랜.md): 스텝페이의 가격 플랜은 상품의 가격을 유연하게 설정할 수 있도록 가격 플랜을 제공합니다. 가격 플랜은 크게 단건, 구독, 번들로 나뉘며 해당 유형을 인지하고 상품을 생성해야 합니다.
- [사용량 기반 요금제 가이드](https://docs.steppay.kr/docs/04-1_사용량.md): 사용량/계정수 기반 요금제는 사용자가 실제로 사용한 양에 따라 요금이 부과되는 가격 플랜입니다. API 호출 횟수, 스토리지 사용량, 등록된 계정수 등에 따라 결제 금액이 산정되는 요금제를 만들때 유용합니다.
- [계정수 기반 요금제 가이드](https://docs.steppay.kr/docs/04-2_계정수.md): 사용량/계정수 기반 요금제는 사용자가 실제로 사용한 양에 따라 요금이 부과되는 가격 플랜입니다. API 호출 횟수, 스토리지 사용량, 등록된 계정수 등에 따라 결제 금액이 산정되는 요금제를 만들때 유용합니다.
- [주문 가이드](https://docs.steppay.kr/docs/05_주문.md): 스텝페이에서 주문과 주문 아이템의 관계, 주문 생성 방법, 주문 타입 및 상태에 대한 상세 가이드
- [구독 가이드](https://docs.steppay.kr/docs/06_구독.md): 구독 생성, 생명주기, 상태 관리, 결제 수단 변경 및 연동 방법에 대한 종합 가이드
- [결제 가이드](https://docs.steppay.kr/docs/07-0_결제.md)
- [관리형(Managed) 결제 가이드](https://docs.steppay.kr/docs/07-1_Managed_결제.md)
- [비관리형(Self) 결제 가이드](https://docs.steppay.kr/docs/07-2_Self_결제.md)
- [웹훅 이벤트 ](https://docs.steppay.kr/docs/08-1-1_Webhook-Events.md): 스텝페이가 제공하는 웹훅 이벤트 목록과 각 이벤트별 이벤트 타입 및 스키마 정보
- [웹훅 스키마](https://docs.steppay.kr/docs/08-1-2_Webhook-Schema.md): 웹훅 v2에서 제공되는 다양한 도메인별 스키마 상세 정보와 데이터 구조
- [Webhook 검증 (Signature)](https://docs.steppay.kr/docs/08-1-3_Signature.md): Steppay에서 전송된 웹훅 데이터의 무결성을 검증하는 방법과 검증 코드 예시
- [웹훅 V2](https://docs.steppay.kr/docs/08-1_웹훅_v2.md): 스텝페이에서 발생하는 다양한 이벤트를 실시간으로 알려주는 웹훅 V2의 사용 방법과 연동 가이드
- [웹훅 V1 (deprecated)](https://docs.steppay.kr/docs/08-2_웹훅-v1.md)
- [웹훅 가이드](https://docs.steppay.kr/docs/08_웹훅.md)
- [구독 매니저 SDK 가이드](https://docs.steppay.kr/docs/09-1_구독매니저_SDK.md): 구독자가 직접 구독 관리를 할 수 있도록 제공하는 SDK의 사용 방법과 세션 생성 및 임베딩 방법
- [결제 SDK 가이드](https://docs.steppay.kr/docs/09-2_결제_SDK.md)
- [Iframe 가이드](https://docs.steppay.kr/docs/10-1_Iframe.md): 스텝커버에서 제공하는 다양한 화면의 Iframe 호출 URL, 파라미터 및 postMessage 형식 안내
- [환영합니다](https://docs.steppay.kr/index.md): 스텝페이 개발 가이드에 오신 것을 환영합니다.

## OpenAPI Specs

- [steppay_v1](https://docs.steppay.kr/steppay_v1.json)
- [openapi](https://docs.steppay.kr/api-reference/openapi.json)