getProductDiscountHistoryList

Prev Next

Classic/VPC環境で利用できます。

アカウントに付与されたサービス料金割引の状況と使用履歴を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET、POST /discount/getProductDiscountHistoryList

リクエストヘッダ

NAVERクラウドプラットフォームで共通して使用されるヘッダの詳細は、Ncloud APIの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
pageNo Integer Optional ページ番号
pageSize Integer Optional ページサイズ
  • 1,000以下(デフォルト: 1,000)
discountNoList.N List<String> Optional 照会対象のサービス割引番号
  • 未入力時、全割履歴を返す
  • 割引番号はgetDiscountListアクションを通じて確認
isOrganization Boolean Optional Organizationサービスアカウントの統合照会かどうか
  • マスターのみ使用可能
  • isOrganization、isPartnerのいずれもtrueの場合、エラーを返す
isPartner Boolean Optional パートナーアカウントの照会かどうか
  • パートナー代表のみ使用可能
  • isOrganization、isPartnerのいずれもtrueの場合、エラーを返す
memberNoList List<String> Optional 会員番号リスト
  • マスターまたはパートナー代表のみ使用可能
startMonth String Optional 照会開始月(yyyyMM)
  • <例> 202401
endMonth String Optional 照会最終月(yyyyMM)
  • <例> 202403
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

リクエストのサンプルコードは次の通りです。

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}' \

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、ProductDiscountHistoryListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

<?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>