リファレンス: 課金詳細情報 CSV リファレンス | 利用料金 (支払明細) を確認する

課金詳細情報 CSV の取得方法については、利用料金を確認する / 課金詳細情報 CSV をダウンロードするを参照してください。

構造

CSV ファイルは、大きく分けて「金額項目」と「補足情報項目」、「課金レコード」と「割引レコード」に分かれています。

CSVファイルの構造

各項目の意味は以下のとおりです。

ヘッダー行 (1 行目)

ヘッダー行には、項目名が並びます。項目名は、大きく分けて「金額項目」と「補足情報項目」に分かれ、金額項目のあとに補足情報項目が出力されます。「金額項目」「補足情報項目」はいずれも可変のため、プログラムで取り込む場合は、CSV ファイル読み込み時の注意点を参考にしてください。

金額項目

「金額項目」に出力される項目名は以下のとおりです。

項目	説明
`imsi` (*1)	IoT SIM の IMSI。IoT SIM に無関係の課金項目 (VPG や無料枠など) の場合は、値が出力されません。
`vpgId` (*1)	SORACOM Canal/Direct で使用する Virtual Private Gateway (VPG) の ID。VPG に無関係の課金項目 (IoT SIM や無料枠など) の場合は、値が出力されません。
`loraGatewayId` (*1)	LoRaWAN ゲートウェイの ID
`loraDeviceId` (*1)	LoRaWAN デバイスの ID
`sigfoxDeviceId` (*1)	Sigfox デバイスの ID
`deviceId` (*1)	SORACOM Inventory のデバイス ID
`gadgetId` (*1)	Gadget API 対応デバイスの ID
`soraCamDeviceId` (*1)	ソラカメ対応カメラのデバイス ID
`vpgId` (*1)	SORACOM Canal/Direct で使用する Virtual Private Gateway (VPG) の ID。VPG に無関係の課金項目 (IoT SIM や無料枠など) の場合は、値が出力されません。
`date`	対象日/対象月日次課金の課金項目については、対象日が yyyyMMdd 形式で出力されます。月次課金の課金項目については、対象月が yyyyMM 形式で出力されます。無料利用枠については、対象月が yyyyMM 形式で出力されます。
`billItemName`	課金レコードおよび割引レコードを参照してください。
`unitPrice`	料金の単価。たとえばデータ通信料金の場合、1 バイトあたりの費用が出力されます。
`quantity`	課金/割引対象の数量。たとえば、データ通信料金の場合 (`billItemName` が、`uploadDataCharge` または `downloadDataCharge` で始まる場合) は、通信したバイト数が出力されます。
`amount`	項目の金額。`unitPrice` × `quantity` の値が出力されます。

(*1) 利用状況によっては出力されません。

補足情報項目

「補足情報項目」に出力される項目名は以下のとおりです。

項目	説明
`simId` (*2)	IoT SIM の SIM ID。IoT SIM に無関係の課金項目 (VPG や無料枠など) の場合は、値が出力されません。
IoT SIM に設定したタグの名前	IoT SIM に設定したタグの値。出力例については、IoT SIM / グループの設定例を参照してください。 IoT SIM に設定した名前は、`name` として出力されます。なお、IoT SIM に無関係の課金項目 (VPG や無料枠など) の場合は、値が出力されません。
`group:groupId` (*2)	グループ ID。グループに無関係の課金項目 (VPG や無料枠など) の場合は、値が出力されません。
`group:name` (*2)	グループ名。グループにに無関係の課金項目 (VPG や無料枠など) の場合は、値が出力されません。
グループに設定したタグの名前	グループに設定したタグの値。出力例については、IoT SIM / グループの設定例を参照してください。

(*2) 利用状況によっては出力されません。

補足情報項目に出力される情報は、CSV を出力した時点の情報です。

料金が発生したタイミングの情報ではありません。

IoT SIM / グループの設定例

IoT SIM (1)
- 名前 : MySIM 1
- SIM ID: 89423xxxxxxxxxxxxx1
- タグ名: tag1, 値: foo
- グループ
  - グループ ID : xxxxxxxx-xxxx-xxxx-xxxx-51d1f069bc06
  - グループ名 : グループ 1
  - タグ名: g_tag2, 値: bar
IoT SIM (2)
- 名前 : MySIM 2
- SIM ID: 89423xxxxxxxxxxxxx2
- タグ名: tag1, 値: foofoo
- グループ
  - グループ ID : xxxxxxxx-xxxx-xxxx-xxxx-51d1f069bc06
  - グループ名 : グループ 1
  - タグ名: g_tag2, 値: bar
IoT SIM (3)
- 名前 : MySIM 3
- SIM ID: 89423xxxxxxxxxxxxx3
- タグ名: tag2, 値: foofoofoo
- グループ
  - グループ ID : xxxxxxxx-xxxx-xxxx-xxxx-20dd1f380e95
  - グループ名 : グループ 2
  - タグ名: g_tag2, 値: barbar

CSV ファイルの出力例:

...,name,simId,tag1,tag2,group:groupId,group:name,group:g_tag2
...,MySIM 1,89423xxxxxxxxxxxxx1,foo,,xxxxxxxx-xxxx-xxxx-xxxx-51d1f069bc06,グループ 1,bar
...,MySIM 2,89423xxxxxxxxxxxxx2,foofoo,,xxxxxxxx-xxxx-xxxx-xxxx-51d1f069bc06,グループ 1,bar
...,MySIM 3,89423xxxxxxxxxxxxx3,,foofoofoo,xxxxxxxx-xxxx-xxxx-xxxx-20dd1f380e95,グループ 2,barbar

レコード行 (2 行目以降)

2 行目以降は、レコード行となります。レコード行は「課金レコード」と「割引レコード」に分かれており、課金レコードの次に割引レコードが出力されます。

課金レコードは、IMSI/VPG ID ごと、日ごと、課金項目ごとにレコードが作成され、quantity (数量) や金額 (amount) は日 (UTC) ごとに合算されます。また IMSI や VPG に関する補足情報が存在する場合は、補足情報項目部分にその値が出力されます。

割引レコードは、無料利用枠やクーポン利用で利用金額から割引される項目が出力されます。日付 (date) 項目に対象の月が入ります。また金額 (amount) の値として、割引額がマイナスで入ります。

なお、この CSV には消費税および合計金額に該当する項目はないため、請求金額と合わせる場合は、すべての金額 (amount) を合算後、消費税率をかけ小数点以下を切り上げしてください。

billItemName 項目一覧

課金レコード

課金レコード	内容
basicCharge-ready	基本料金 (SIM 利用料金:ready 時)
basicCharge-active	基本料金 (SIM 利用料金:Active 時)
basicCharge-inactive	基本料金 (SIM 利用料金:Inactive 時)
basicCharge-suspended	基本料金 (SIM 利用料金:Suspended 時)
basicMonthlyChargeForPlanKM1	基本料金 (plan-KM1 基本料)
subscriberSuspensionCharge	Suspended への変更料金
subscriberActivationCharge	Standby からのアクティブ化料金
subscriberContractRenewalCharge	SIM の契約更新料金
dataTrafficChargeForPlanKM1	データ通信料金 (plan-KM1)
subscriberActivationChargeForPlanKM1	plan-KM1 ready/suspended からの Activate 料金
contractRenewalChargeForPlanKM1	plan-KM1 「準備完了」、「利用開始待ち」の状態で 1 年を経過した場合の契約更新料
uploadDataCharge-xxxx-xxxx	日本カバレッジの IoT SIM の上り (デバイスから SORACOM) のデータ通信料金。速度クラス (`s1.fast` など) と時間帯 (`daytime`、`nighttime`) がハイフン区切りで付与されます。例) uploadDataCharge-s1.fast-daytime
downloadDataCharge-xxxx-xxxx	日本カバレッジの IoT SIM の下り (SORACOM からデバイス) のデータ通信料金。速度クラス (`s1.fast` など) と時間帯 (`daytime`、`nighttime`) がハイフン区切りで付与されます。例) downloadDataCharge-s1.fast-nighttime
dataTrafficCharge-xxx-xxxx	グローバルカバレッジの IoT SIM のデータ通信料金。国/地域とサブスクリプションがハイフン区切りで付与されます。
dataTrafficRoundedUpCharge-xxx-xxxx	グローバルカバレッジの IoT SIM のデータ通信料金。課金単位で切り上げられたデータ通信料金を算出するための調整料金です。国/地域とサブスクリプションがハイフン区切りで付与されます。
subscriptionDeliveryCharge-xxxx	サブスクリプション追加費用 (planP1/planX1/planX2/planX3/plan-US-max)
subscriptionUsageCharge-xxxx	サブスクリプション利用料金 (planP1/planX1/planX2/planX3/plan-US-max)
subscriptionContractRenewalCharge-xxxx	サブスクリプション年間契約更新料金 (planP1/planX1/planX2/planX3/plan-US-max)
esimProfileInitialCharge-xxxx	eSIM プロファイル初期費用。サブスクリプションがハイフン区切りで付与されます。例) esimProfileInitialCharge-plan01s
bundleChargeForPlanDU-xxxx	plan-DU 月額料金
additionalDataCapacityChargeForPlanDU	plan-DU 追加料金 (上り 10GiB/下り 1GiB 単位)
readyStatusChargeForPlanDU	plan-DU 準備完了状態時の料金
readyStatusChargeForPlanDWithBundle	plan-D バンドルプラン準備完了状態時の料金 (plan-D D-300MB)
suspendedStatusChargeForPlanDWithBundle	plan-D バンドルプラン利用中断中状態時の料金 (plan-D D-300MB)
bundleChargeForPlanDWithBundle-xxxx	plan-D バンドルプラン月額料金 (plan-D D-300MB)
additionalDataCapacityChargeForPlanDWithBundle	plan-D バンドルプラン追加料金 (500MiB 単位) (plan-D D-300MB)
readyStatusChargeForPlanK2WithBundle	plan-K2 バンドルプラン準備完了状態時の料金 (plan-K2 K2-300MB)
suspendedStatusChargeForPlanK2WithBundle	plan-K2 バンドルプラン利用中断中状態時の料金 (plan-K2 K2-300MB)
bundleChargeForPlanK2WithBundle-xxxx	plan-K2 バンドルプラン月額料金 (plan-K2 K2-300MB)
additionalDataCapacityChargeForPlanK2WithBundle	plan-K2 バンドルプラン追加料金 (500MiB 単位) (plan-K2 K2-300MB)
soracomArcVirtualSimInitialCharge	SORACOM Arc 初回費用
soracomArcVirtualSimWithSimMonthlyCharge	SORACOM Arc 月額利用料金 (SORACOM IoT SIM に追加した場合)
soracomArcVirtualSimWithoutSimMonthlyCharge	SORACOM Arc 月額利用料金 (単独で作成した場合)
soracomArcVirtualSimDateTrafficCharge	データ通信料金 (SORACOM Arc)
chapAuthenticationCharge	CHAP 認証の SIM ごとの料金
customDNSCharge	CustomDNS の SIM ごとの料金
ussdRequestCharge	USSD リクエスト利用料金
planKM1LocationOptionCharge	plan-KM1 位置情報利用料金
planKM1LocationOptionRequestCharge	plan-KM1 位置情報利用料金リクエスト利用料金
virtualPrivateGatewaySetupCharge	Virtual Private Gateway のセットアップ料金 (2016 年 4 月までの分)
virtualPrivateGatewayCanalSetupCharge	SORACOM Canal 用の Virtual Private Gateway セットアップ料金
virtualPrivateGatewayDirectSetupCharge	SORACOM Direct 用の Virtual Private Gateway セットアップ料金
virtualPrivateGatewayDoorSetupCharge	SORACOM Door 用の Virtual Private Gateway セットアップ料金
virtualPrivateGatewayCharge	Virtual Private Gateway の SIM ごとの利用料金
soracomCanalVirtualPrivateGatewayCharge	SORACOM Canal 用 Virtual Private Gateway の利用料金
soracomCanalVPCPeeringCharge	SORACOM Canal の Peering 機能の利用料金
soracomDirectVirtualPrivateGatewayCharge	SORACOM Direct 用 Virtual Private Gateway の料金
soracomDirectVirtualInterfaceCharge	SORACOM Direct の Virtual Interfase ごとの料金
soracomDoorVirtualPrivateGatewayCharge	SORACOM Door 用 Virtual Private Gateway の料金
soracomDoorVPNConnectionCharge	SORACOM Door の VPN 接続ごとの料金
virtualPrivateGatewayFixedGlobalIpAddressOptionCharge	VPG 固定 IP アドレスオプション時間課金
virtualPrivateGatewayTypeESetupCharge	VPG Type-E のセットアップ料金
virtualPrivateGatewayTypeECharge	VPG Type-E の VPG の利用料金
virtualPrivateGatewayTypeFSetupCharge	VPG Type-F のセットアップ料金
virtualPrivateGatewayTypeFCharge	VPG Type-F の VPG の利用料金
virtualPrivateGatewayTypeGSetupCharge	VPG Type-G のセットアップ料金
virtualPrivateGatewayTypeGCharge	VPG Type-G の VPG の利用料金
soracomBeamRequestCharge-xxx	SORACOM Beam リクエスト利用料金。プロトコル名がハイフン区切りで付与されます。
soracomEndorseCharge	SORACOM Endorse 利用料金
soracomFunnelRequestCharge-xxx	SORACOM Funnel リクエスト利用料金。プロトコル名がハイフン区切りで付与されます。
soracomFunkRequestCharge-xxx	SORACOM Funk リクエスト利用料金。呼び出し先の Functions 名がハイフン区切りで付与されます。
soracomHarvestCharge	SORACOM Harvest Data 利用料金
soracomHarvestRequestCharge	SORACOM Harvest Data 利用料金 (2000 リクエスト超過分)
soracomHarvestTermExtensionCharge	SORACOM Harvest Data のデータ保持期間延長オプション料金。詳しくは、SORACOM Harvest Data のデータ保持期間を延長するを参照してください。
soracomHarvestDataExportCharge	SORACOM Harvest Data のデータエクスポート料金。データ保持期間延長オプションを有効化すると発生します。詳しくは、SORACOM Harvest Data のデータ保持期間を延長するを参照してください。
soracomHarvestFilesStoreCharge	SORACOM Harvest Files データ保存料金
soracomHarvestFilesExportCharge	SORACOM Harvest Files データエクスポート費用
soracomInventoryDeviceRegistrationCharge	SORACOM Inventory デバイス登録料金
soracomInventoryMonthlyCharge	SORACOM Inventory 月額利用料金
soracomInventoryEventCharge	SORACOM Inventory イベント利用料金
soracomJunctionCharge	SORACOM Junction の料金
soracomJunctionInspectionCharge	SORACOM Junction インスペクションの料金
soracomKryptonInitialProvisioningCharge	SORACOM Krypton 初回プロビジョニング利用料金
soracomKryptonMonthlyProvisioningCharge	SORACOM Krypton 月額セットアップ利用料金
soracomLagoonMonthlyCharge-xxx	SORACOM Lagoon 月額費用。プラン名がハイフン区切りで入ります
soracomLagoonLicensePackCharge-xxx	SORACOM Lagoon ライセンスパック料金。パック名がハイフン区切りで付与されます。
soracomNapterCharge	SORACOM Napter 利用料金
soracomNapterAuditLogCharge	SORACOM Napter 監査ログ利用料金
soracomNapterAuditLogExportCharge	SORACOM Napter 監査ログエクスポート料金
soracomOrbitCharge	SORACOM Orbit 料金
soracomOrbitRequestCharge	SORACOM Orbit リクエスト料金
soracomPeekChargeForVPG	SORACOM Peek 料金 for VPG
soracomPeekDataExportCharge	SORACOM Peek データエクスポート料金
soracomPeekDataStoreChargeForVPG	SORACOM Peek データ保存料金 for VPG
soracomLTEMButtonPoweredByAWSRenewalCharge	SORACOM LTE-M Button powered by AWS の契約更新料金
loRaGatewayOwnedModelFirstUnitMonthlyCharge	LoRa ゲートウェイ専有モデル月額費用 (1 台目)
loRaGatewayOwnedModelAdditionalUnitMonthlyCharge	LoRa ゲートウェイ専有モデル月額費用 (2 台目以降)
loRaGatewaySharedServiceModelMonthlyCharge	LoRa ゲートウェイ共有モデル月額費用 (1 台目)
sigfoxMessageCharge	Sigfox メッセージ利用料金。契約内容や利用国などがハイフン区切りで付与されます。
sigfoxDeviceRegistrationCharge	Sigfox デバイス登録料金
sigfoxAnnualConnectivityCharge	Sigfox デバイス年間接続料金
docomoSMSCharge	SMS 料金 (NTT ドコモ)
docomoInternatinalSMSCharge	国際 SMS 料金 (NTT ドコモ)
kddiSMSCharge-yyyyMM	SMS 料金 (KDDI) yyyyMM に利用月が入ります。
kddiInternatinalSMSCharge-yyyyMM	国際 SMS 料金 (KDDI) yyyyMM に利用月が入ります。
soracomSmsDeliveryCharge	Soracom SMS 配信利用料金
soracomSmsSubmitCharge	Soracom SMS 送信利用料金
apiAuditLogEnterpriseOptionCharge	監査ログエンタープライズオプション料金
apiAuditLogExportCharge	監査ログエクスポート料金 (10G / 月超過分)
soraCamLicenseCharge-continuousRecording7Days-CR7-SC	ソラカメのクラウド常時録画ライセンス (7 日間)
soraCamLicenseCharge-continuousRecording14Days-CR14-SC	ソラカメのクラウド常時録画ライセンス (14 日間)
soraCamLicenseCharge-continuousRecording30Days-CR30-SC	ソラカメのクラウド常時録画ライセンス (30 日間)
soraCamLicenseCharge-continuousRecording7Days-CR7-SC-upfront_12_months-MM	ソラカメのクラウド常時録画ライセンス (7 日間) の 12 か月前払いプランの料金。MM に課金された月数 (01 から 12 まで) が入ります。
soraCamLicenseCharge-continuousRecording14Days-CR14-SC-upfront_12_months-MM	ソラカメのクラウド常時録画ライセンス (14 日間) の 12 か月前払いプランの料金。MM に課金された月数 (01 から 12 まで) が入ります。
soraCamLicenseCharge-continuousRecording30Days-CR30-SC-upfront_12_months-MM	ソラカメのクラウド常時録画ライセンス (30 日間) の 12 か月前払いプランの料金。MM に課金された月数 (01 から 12 まで) が入ります。
soraCamLicenseCharge-motionDetectionUnlimitedRecording7Days-MR7-SC	ソラカメのクラウドモーション検知 “無制限” 録画ライセンス (7 日間)
soraCamLicenseCharge-motionDetectionUnlimitedRecording14Days-MR14-SC	ソラカメのクラウドモーション検知 “無制限” 録画ライセンス (14 日間)
soraCamLicenseCharge-motionDetectionUnlimitedRecording30Days-MR30-SC	ソラカメのクラウドモーション検知 “無制限” 録画ライセンス (30 日間)
soraCamLicenseCharge-motionDetectionUnlimitedRecording7Days-MR7-SC-upfront_12_months-MM	ソラカメのクラウドモーション検知 “無制限” 録画ライセンス (7 日間) の 12 か月前払いプランの料金。MM に課金された月数 (01 から 12 まで) が入ります。
soraCamLicenseCharge-motionDetectionUnlimitedRecording14Days-MR14-SC-upfront_12_months-MM	ソラカメのクラウドモーション検知 “無制限” 録画ライセンス (14 日間) の 12 か月前払いプランの料金。MM に課金された月数 (01 から 12 まで) が入ります。
soraCamLicenseCharge-motionDetectionUnlimitedRecording30Days-MR30-SC-upfront_12_months-MM	ソラカメのクラウドモーション検知 “無制限” 録画ライセンス (30 日間) の 12 か月前払いプランの料金。MM に課金された月数 (01 から 12 まで) が入ります。
soraCamCellularPackMonthlyCharge-wimax	ソラカメ専用セルラーパック月額料金
soraCamDataExportCharge	ソラカメの「動画のエクスポート可能時間の消費時間」が 72 時間を超過した場合の追加料金
soraCamDeviceAtomCamUnlimitedLiveStreamCharge	ソラカメのライブ視聴見放題料金
soraCamDeviceStatusNotificationCharge	ソラカメの通知オプションの「デバイスのオフライン / オンライン / 録画停止の通知」利用料金
soraCamDeviceEventNotificationCharge-xxxx	ソラカメの通知オプションの「デバイスのモーション検知 / サウンド検出の通知」利用料金。email や webhook などの通知手段がハイフン区切りで付与されます。

割引レコード

割引レコード	内容
dataTrafficFreeTier	データ通信無料利用枠
soracomArcVirtualSimInitialChargeFreeTier	SORACOM Arc 仮想 SIM 初期費用無料利用枠
soracomArcVirtualSimWithSimMonthlyChargeFreeTier	SORACOM Arc 月額料金無料利用枠 (SORACOM IoT SIM に追加した場合)
soracomArcVirtualSimWithoutSimMonthlyChargeFreeTier	SORACOM Arc 月額料金無料利用枠 (単独で作成した場合)
soracomBeamRequestFreeTier	Soracom Beam リクエスト無料利用枠
soracomEndorseFreeTier	Soracom Endorse 無料利用枠
soracomFunnelRequestFreeTier	Soracom Funnel リクエスト無料利用枠
soracomFunkRequestFreeTier	Soracom Funk リクエスト無料利用枠
soracomHarvestFreeTier	Soracom Hearvest 無料利用枠
soracomInventoryFreeTier	Soracom Inventory リクエスト無料利用枠
soracomNapterFreeTier	Soracom Napter 無料利用枠
dataTrafficCoupon	データ通信へのクーポン充当枠
soracomBeamRequestCoupon	Soracom Beam リクエスト利用料へのクーポン充当枠
soracomEndorseCoupon	Soracom Endorse 利用料へのクーポン充当枠
soracomFunnelRequestCoupon	Soracom Funnel 利用料へのクーポン充当枠
chargeCoupon	SORACOM 利用料全体へのクーポン充当枠
soracomAirBasicChargeVolumeDiscount	基本料金のボリュームディスカウント

CSV ファイル読み込み時の注意点

ファイルのエンコード

BOM つきの UTF-8 でエンコードされています。

エスケープおよび改行

補足情報項目の値に使用する文字によっては、以下のように処理されます。CSV ファイルを読み込むときは、このルールに従って処理してください。

補足情報項目の値にカンマ (,) や改行コードが入っている場合は、値がダブルクォーテーション (") で括られます。
補足情報項目の値にダブルクォーテーション (") が入っている場合は、ダブルクォーテーション ("") でエスケープされます。

データ項目

データ項目は出力するデータにあわせて増減します。また、SORACOM プラットフォームの仕様変更により増減することがあります。

そのため、ヘッダー行とレコード行を正しく組み合わせて読み込んでください。

NG 例: CSV ファイルの 1 項目目が IMSI、2 項目目が date という前提でデータを取り扱う。SORACOM Canal/Direct を使用すると date の前に vpgId が出力されて項目の順番が変わるため、将来、正しくデータを取り扱えなくなる可能性があります。

OK 例: CSV ファイルのすべてのデータを、キーと値の組み合わせで扱えるオブジェクト (ハッシュ、連想配列など) に正しく記録してから取り扱う。