getDiscountList

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

계정이 보유하고 있는 할인 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET, POST /discount/getDiscountList

요청 헤더

Discount API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Discount 공통 헤더를 참조해 주십시오.

요청 쿼리 파라미터

파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
pageNo Integer Optional 페이지 번호
pageSize Integer Optional 페이지 크기
  • 1,000 이하(기본값: 1,000)
isOrganization Boolean Optional Organization 서비스 계정 통합 조회 여부
  • 마스터만 사용 가능
  • isOrganization, isPartner 모두 true이면 에러 응답
isPartner Boolean Optional 파트너 계정 조회 여부
  • 파트너 대표만 사용 가능
  • isOrganization, isPartner 모두 true이면 에러 응답
memberNoList List<String> Optional 회원 번호 목록
  • 마스터 또는 파트너 대표만 사용 가능
discountTypeCode String Optional 할인 유형
  • PRODUCT | CREDIT | COIN
    • PRODUCT: 서비스 요금 할인
    • CREDIT: 크레딧
    • COIN: 코인
startMonth String Optional 조회 시작 월(yyyyMM)
  • 최대 3개월 조회 가능
  • <예시> 202401
endMonth String Optional 조회 마지막 월(yyyyMM)
  • 최대 3개월 조회 가능
  • <예시> 202403
isValidDiscount Boolean Optional 유효한 할인만 조회 여부
  • true | false
    • true: 유효한 할인만 조회
    • false: 모든 할인 조회
responseFormatType String Optional 응답 결과의 형식
  • xml (기본값) | json

요청 예시

요청 예시는 다음과 같습니다.

curl --location  --request GET 'https://billingapi.apigw.gov-ntruss.com/billing/v1/discount/getDiscountList?startMonth=202401&endMonth=202403&isValidDiscount=true&responseFormatType=xml' \
--header 'x-ncp-apigw-timestamp: {timestamp}' \
--header 'x-ncp-iam-access-key: {access key}' \
--header 'x-ncp-apigw-signature-v2: {signature}' \

응답

응답 형식을 설명합니다.

응답 바디

응답 바디는 DiscountList를 참조해 주십시오.

응답 상태 코드

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 자세한 내용은 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

<?xml version="1.0" encoding="UTF-8"?>
<getDiscountListResponse>
  <requestId>b797****-****-****-****-****6fab4b70</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>2</totalRows>
  <discountList>
    <discount>
      <memberNo>******</memberNo>
      <discountNo>54</discountNo>
      <discountType>
        <code>COIN</code>
        <codeName>Coin</codeName>
      </discountType>
      <discountName>계좌이체(농협)</discountName>
      <discountProcessMethod>
        <code>FXSUM</code>
        <codeName>Flat rate</codeName>
      </discountProcessMethod>
      <discountValue>100000</discountValue>
      <validityStartMonth>202007</validityStartMonth>
      <validityEndMonth>202307</validityEndMonth>
    </discount>
    <discount>
      <memberNo>******</memberNo>
      <discountNo>158</discountNo>
      <discountType>
        <code>COIN</code>
        <codeName>Coin</codeName>
      </discountType>
      <discountName>신용카드(TEST)</discountName>
      <discountProcessMethod>
        <code>FXSUM</code>
        <codeName>Flat rate</codeName>
      </discountProcessMethod>
      <discountValue>10000</discountValue>
      <validityStartMonth>202007</validityStartMonth>
      <validityEndMonth>202307</validityEndMonth>
    </discount>
  </discountList>
</getDiscountListResponse>