Get Billing Details¶

GET /api/v1/billing/detail/list

Overview¶

Query Parameters¶

Parameter	Type	Required	Description
startDate	string		Billing start date format: 20230731 Example: 20230731 Allow empty: False
endDate	string		Billing end date format: 20230731 Example: 20230731 Allow empty: False

Additional Parameter Description¶

Response parameter description:

content Structure Description

Parameter	Description
consumeTimeOfDay	Billing consumption time
orgName	Billing Center organization name can be ignored
productName	Product name fixed dataFlux
productDetail	Product details
billingKey	Billing category key
billingCycle	Billing cycle Day, Month, Year, Single
billingResult	Payable
deductionAmount	Deduction amount
oweAmount	Owed amount
originAmount	Original price
serviceBillingAmount	Service Charges can be ignored
couponAmount	Coupon deduction
storedCardAmount	Stored card deduction
cashAmount	Cash deduction
cashCouldAmount	Cloud market deduction
commodityCategory	Product type subscription, pay-as-you-go
consumePlatform	Billing method
customerIdentifier	Cloud market account
consumption	Can be ignored
workspaceUuid	Workspace uuid
workspaceName	Workspace name
consumeTime	Consumption timestamp
billingResultDetails	Can be ignored
count	Usage

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/billing/detail/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--compressed

Response¶

{
    "code": 200,
    "content": [
        {
            "consumeTimeOfDay": "2023-07-31",
            "orgName": "None",
            "productName": "None",
            "productDetail": "Session Replay",
            "billingCycle": "None",
            "billingResult": 0,
            "deductionAmount": "None",
            "oweAmount": "None",
            "originAmount": 0,
            "serviceBillingAmount": "None",
            "couponAmount": "None",
            "storedCardAmount": "None",
            "cashAmount": "None",
            "cashCouldAmount": "None",
            "commodityCategory": "None",
            "consumePlatform": "None",
            "customerIdentifier": "None",
            "consumption": "None",
            "workspaceUuid": "None",
            "workspaceName": "None",
            "consumeTime": "None",
            "tag6": "session_replay",
            "billingResultDetails": "None",
            "count": 0
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-192EB1B1-ACBA-4942-A4F1-34A1A9F93C0C"
}