ログインしたアカウントの請求情報を照会する

ログインしたアカウントの請求情報を照会します。

リクエスト

基本情報
HTTP URL	https://cloud-api.celerdata.com/api/1.0/bills
HTTP メソッド	GET
頻度	600/分

ヘッダー パラメータ

パラメータ	例	必須	タイプ	説明
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	はい	String	CelerData Cloud BYOC API にアクセスするために使用されるアクセストークン。フォーマット: Bearer <access_token>。

アクセストークンを取得する を参照してください。

クエリ パラメータ

パラメータ	例	必須	タイプ	説明
start_month	202304	はい	String	照会する期間の開始月。フォーマット: yyyyMM。
end_month	202307	はい	String	照会する期間の終了月。フォーマット: yyyyMM。 start_month は end_month 以下でなければならず、start_month から start_month を引いた結果は 0 から 36 の範囲でなければなりません。

レスポンス

サンプル レスポンス

{
    "code":20000,
    "data":{
        "account_id":"lbyx0bt7a",
        "begin_month":202304,
        "end_month":202307,
        "bill_list":[
            {
                "period":"202304",
                "account_id":"lbyx0bt7a",
                "charge_usage":"701.536682",
                "charge_price":"350.76",
                "bill_state":"PAID",
                "pay_state":"SUCCESS",
                "pay_method":"AccountBalance",
                "pay_info_details":[
                    {
                        "pay_method":"AccountBalance",
                        "amount":"701.536682",
                        "currency":"CCU",
                        "state":"SUCCESS"
                    }
                ]
            }
        ]
    }
}

レスポンス要素

パラメータ	例	タイプ	説明
code	20000	Integer	エラーコード。エラーコードが 20000 の場合、リクエストは成功しました。他のエラーコードが返された場合、リクエストは失敗しました。
data	-	Object	API 呼び出しの結果。いくつかの API アクションでは data オブジェクトが返されない場合があります。以下の要素で構成されます: account_id begin_month end_month bill_list
data.account_id	lbyx0bt7a	String	照会されたアカウントの ID。
data.begin_month	202304	Integer	照会された期間の開始月。
data.end_month	202307	Integer	照会された期間の終了月。
data.bill_list	-	Array	選択された期間のアカウントの請求詳細。bill_list は 1 つ以上のオブジェクトで構成される配列であり、選択された期間内の月数に応じて、各月の請求詳細を含みます。
data.bill_list.0	-	Object	各特定の月のアカウントの請求詳細であり、オブジェクトとして提示されます。各オブジェクトは以下の要素で構成されます: period account_id bill_state charge_usage charge_price pay_state pay_method pay_info_details
data.bill_list.0.period	202304	String	請求月。フォーマット: yyyyMM。
data.bill_list.0.account_id	lbyx0bt7a	String	照会されたアカウントの ID。
data.bill_list.0.bill_state	PAID	String	請求書のステータス。有効な値: NOT_BILLED: 請求書が生成されていません。 BILLED: 請求書が生成されました。 WAIT_PAY: 支払い待ちの請求書です。 PAYMENT_SUBMITTED: 支払いが提出されました。 PAID: 請求書が支払われました。 ERROR: 請求書にエラーがあります。
data.bill_list.0.charge_usage	701.536682	String	アカウントに課金された使用量。単位: CCU。この要素は、bill_state の返り値が PAYMENT_SUBMITTED または PAID の場合にのみ返されます。
data.bill_list.0.charge_price	350.76	String	アカウントに課金された金額。単位: USD。この要素は、bill_state の返り値が PAYMENT_SUBMITTED または PAID の場合にのみ返されます。
data.bill_list.0.pay_state	SUCCESS	String	支払いのステータス。有効な値: PROCESSING: 支払いが処理中です。 SUCCESS: 支払いが完了しました。 FAILED: 支払いが失敗しました。 VOID: 支払いがキャンセルされました。 この要素は、bill_state の返り値が PAYMENT_SUBMITTED または PAID の場合にのみ返されます。
data.bill_list.0.pay_method	AccountBalance	String	使用された支払い方法。有効な値: AccountBalance: アカウント残高内の CCU を使用して請求書が支払われます。 CreditCard: クレジットカードを使用して請求書が支払われます。 CombinePay: CCU とクレジットカードの両方を使用して請求書が支払われます。 この要素は、bill_state の返り値が PAYMENT_SUBMITTED または PAID の場合にのみ返されます。
data.bill_list.0.pay_info_details	-	Array	支払いの詳細。pay_info_details 要素は、1 つ以上のオブジェクトで構成される配列であり、請求書を支払うためにバンドル支払いとして使用した支払い方法の数に応じて、各特定の支払い方法の支払い詳細を含みます。 pay_method の返り値が AccountBalance または CreditCard の場合、pay_info_details 要素は 1 つのオブジェクトで構成されます。 pay_method の返り値が CombinePay の場合、pay_info_details 要素は 2 つのオブジェクトで構成されます: 1 つのオブジェクトは CCU ベースの支払い詳細を含み、もう 1 つはクレジットカードベースの支払い詳細を含みます。 この要素は、bill_state の返り値が PAYMENT_SUBMITTED または PAID の場合にのみ返されます。
data.bill_list.0.pay_info_details.0	-	Object	支払いの詳細であり、オブジェクトとして提示されます。各オブジェクトは以下の要素で構成されます: pay_method amount currency state
data.bill_list.0.pay_info_details.0.pay_method	AccountBalance	String	支払い方法。有効な値: AccountBalance: アカウント残高内の CCU を使用して請求書が支払われます。 CreditCard: クレジットカードを使用して請求書が支払われます。
data.bill_list.0.pay_info_details.0.amount	701.536682	String	支払われた金額。
data.bill_list.0.pay_info_details.0.currency	CCU	String	支払いが行われた通貨。有効な値: CCU および USD。
data.bill_list.0.pay_info_details.0.state	SUCCESS	String	支払いのステートメント。有効な値: PROCESSING: 支払いが処理中です。 SUCCESS: 支払いが完了しました。 FAILED: 支払いが失敗しました。 VOID: 支払いがキャンセルされました。
message	param end_month should less than current month.	String	エラーメッセージ。この要素は、返された code が 20000 でない場合にのみ返されます。 注意 リクエストが成功したか失敗したかを message の返り値に基づいて判断しないでください。