getProductDemandCostList

Prev Next

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

設定期間に基づいてサービス別請求費用リストを照会します。

リクエスト

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

メソッド URI
GET、POST /cost/getProductDemandCostList

リクエストヘッダ

Cost And Usage APIで共通して使用されるヘッダの詳細は、Cost And Usageの共通ヘッダをご参照ください。

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

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

フィールド タイプ 必須の有無 説明
pageNo Integer Optional ページ番号
pageSize Integer Optional ページサイズ
  • 1,000以下(デフォルト: 1,000)
isOrganization Boolean Optional Organizationサービスアカウントの統合照会かどうか
  • マスターのみ使用可能
  • isOrganizationisPartnerのいずれもtrueの場合、エラーを返す
isPartner Boolean Optional パートナーアカウントの照会かどうか
  • パートナー代表のみ使用可能
  • isOrganizationisPartnerのいずれもtrueの場合、エラーを返す
memberNoList List<String> Optional 会員番号リスト
  • マスターまたはパートナー代表のみ使用可能
startMonth String Required 照会開始月(yyyyMM)
  • 最大3か月照会可能
  • <例> 202401
endMonth String Required 照会最終月(yyyyMM)
  • 最大3か月照会可能
  • <例> 202403
productDemandTypeCode String Optional サービス請求タイプコード
responseFormatType String Optional レスポンス結果の形式
  • xml(デフォルト) | json

リクエスト例

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

curl --location --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/cost/getProductDemandCostList?startMonth=202401&endMonth=202401&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "getProductDemandCostListResponse": {
        "totalRows": 3,
        "productDemandCostList": [
            {
                "memberNo": "2760000",
                "demandMonth": "202401",
                "productDemandType": {
                    "code": "NET_SVR",
                    "codeName": "Network - Server&LoadBalancer",
                    "regionCode": ""
                },
                "promiseDiscountAmount": 0,
                "promotionDiscountAmount": 0,
                "etcDiscountAmount": 0,
                "productDiscountAmount": 0,
                "creditDiscountAmount": 0,
                "defaultAmount": 0,
                "useAmount": 0,
                "demandAmount": 0,
                "writeDate": "2024-02-01T06:23:35+0900",
                "memberPriceDiscountAmount": 0,
                "memberPromiseDiscountAddAmount": 0,
                "payCurrency": {
                    "code": "KRW",
                    "codeName": "South Korea Won"
                },
                "thisMonthAppliedExchangeRate": 1
            },
// (省略)
        ],
        "requestId": "00000029-045b-45f9-b156-53f98b000000",
        "returnCode": "0",
        "returnMessage": "success"
    }
}