API

플랜 목록 조회

작성일 2026.03.14 | 수정일 2026.03.14

GET/cash/v1/plans

Query

planId— 특정 플랜 ID로 조회 (32자)

name— 플랜 이름으로 필터링. 연산자 eq(정확히 일치), like(부분 일치) 사용 가능

startKey— 이전 응답의 nextKey를 전달하여 다음 페이지 조회

limit— 조회 건수 (기본값: 20, 최소: 1)

dateCreated— 생성일 필터(ISO 8601) 연산자 eq, gte, lte, gt, lt 사용

dateUpdated— 수정일 필터(ISO 8601) 연산자 eq, gte, lte, gt, lt 사용

chat

지원 연사자를 사용하실 경우 Query Operator 가이드를 참조하세요

이용 가능한 전체 플랜 목록을 조회합니다. 이름, 생성일, 수정일 등으로 필터링할 수 있습니다.

Response

Name	Type	Required	Description
startKey	string\|null	*	현재 조회의 시작 키
nextKey	string\|null	*	다음 페이지 조회를 위한 키
limit	number	*	요청한 조회 건수
planList	array	*	플랜 목록
planId	string	*	플랜 고유 ID (32자, 'CA01PL' 접두사)
name	string	*	플랜 이름
supplyPrice	number	*	공급가액 (원)
tax	number	*	세금 (원)
totalPrice	number	*	총액 (원). supplyPrice + tax.
useHook	boolean	*	웹훅 사용 여부
hook	object\|null	*	웹훅 설정 정보. useHook이 false이면 null.
url	string	*	웹훅 수신 URL
customData	any		사용자 정의 데이터
dateCreated	string	*	생성 일시 (ISO 8601)
dateUpdated	string	*	최종 수정 일시 (ISO 8601)

Structure

Response

{
  "startKey": null,
  "nextKey": null,
  "limit": 20,
  "planList": [
    {
      "planId": "CA01PL01234567890123456789AB",
      "name": "Basic Plan",
      "supplyPrice": 9091,
      "tax": 909,
      "totalPrice": 10000,
      "useHook": true,
      "hook": {
        "url": "https://example.com/webhook",
        "customData": {
          "tier": "basic"
        }
      },
      "dateCreated": "2024-01-01T00:00:00.000Z",
      "dateUpdated": "2024-06-01T00:00:00.000Z"
    }
  ]
}