getProductDiscountHistoryList

Prev Next

Available in Classic and VPC

View the status and usage history of service fee discounts granted to an account.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET, POST /discount/getProductDiscountHistoryList

Request headers

For headers common to NAVER Cloud Platform, see Common Ncloud API headers.

Request query parameters

The following describes the parameters.

Field Type Required Description
pageNo Integer Optional Page number
pageSize Integer Optional Page size
  • 1000 or less (default: 1000)
discountNoList.N List<String> Optional Service discount number to view
  • Full discount history response if not entered
  • Check the discount number through the getDiscountList action
isOrganization Boolean Optional Whether to view consolidated usage for organization service accounts
  • Available to masters only
  • An error is returned if both isOrganization and isPartner are true
  • isPartner Boolean Optional Whether to view partner accounts
    • Available to partner representatives only
    • An error is returned if both isOrganization and isPartner are true
    memberNoList List<String> Optional Member ID list
    • Only available to master or partner representatives
    startMonth String Optional Query start month (yyyyMM)
    • <E.g.> 202401
    endMonth String Optional Query end month (yyyyMM)
    • <E.g.> 202403
    responseFormatType String Optional Response result format
    • xml (default) | json

    Request example

    The following is a sample request.

    curl --location  --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/discount/getProductDiscountHistoryList?startMonth=202212&endMonth=202212' \
    --header 'x-ncp-apigw-timestamp: {timestamp}' \
    --header 'x-ncp-iam-access-key: {access key}' \
    --header 'x-ncp-apigw-signature-v2: {signature}' \
    

    Response

    The following describes the response format.

    Response body

    See ProductDiscountHistoryList for the response body.

    Response status codes

    For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

    Response example

    The following is a sample response.

    <?xml version="1.0" encoding="UTF-8"?>
    <getProductDiscountHistoryListResponse>
    	<requestId>5bf26617-****-****-****-63497ba24e8a</requestId>
    	<returnCode>0</returnCode>
    	<returnMessage>success</returnMessage>
    	<totalRows>1</totalRows>
    	<productDiscountHistoryList>
    		<productDiscountHistory>
    			<memberNo>*****</memberNo>
    			<productDiscount>
    				<discountNo>9694</discountNo>
    				<productDiscountName>product-discount-test</productDiscountName>
    				<discountRate>10.0</discountRate>
    				<discountCondition>false</discountCondition>
    				<minimumAmount>0</minimumAmount>
    				<maximumDiscountAmount>0</maximumDiscountAmount>
    				<validityStartMonth>202212</validityStartMonth>
    				<validityEndMonth>202212</validityEndMonth>
    				<eligibleProductDemandTypeList>
    					<productDemandType>
    						<code>SCMTR</code>
    						<codeName>Security Monitoring</codeName>
    						<regionCode>KR</regionCode>
    					</productDemandType>
    					<productDemandType>
    						<code>GDNS</code>
    						<codeName>Global DNS</codeName>
    						<regionCode>COM</regionCode>
    					</productDemandType>
    				</eligibleProductDemandTypeList>
    				<payCurrency>
    					<code>KRW</code>
    					<codeName>South Korea Won</codeName>
    				</payCurrency>
    			</productDiscount>
    			<productDiscountUseHistoryList>
    				<productDiscountUseHistory>
    					<useMonth>202212</useMonth>
    					<productDemandType>
    						<code>SCMTR</code>
    						<codeName>Security Monitoring</codeName>
    						<regionCode>KR</regionCode>
    					</productDemandType>
    					<discountTargetAmount>2180930</discountTargetAmount>
    					<discountAppliedAmount>218090</discountAppliedAmount>
    				</productDiscountUseHistory>
    				<productDiscountUseHistory>
    					<useMonth>202212</useMonth>
    					<productDemandType>
    						<code>GDNS</code>
    						<codeName>Global DNS</codeName>
    						<regionCode>COM</regionCode>
    					</productDemandType>
    					<discountTargetAmount>690</discountTargetAmount>
    					<discountAppliedAmount>60</discountAppliedAmount>
    				</productDiscountUseHistory>
    			</productDiscountUseHistoryList>
    		</productDiscountHistory>
    	</productDiscountHistoryList>
    </getProductDiscountHistoryListResponse>