Get Bill Summary

Get Bill Summary

Get metering Bills summary based on the Request

Request
URI
POST
https://{api_host}/suite-api/api/chargeback/bills/query
COPY
Query Parameters
integer
page
Optional
Constraints: default: 0

Page number from which data needs to be displayed (0-based)

integer
pageSize
Optional
Constraints: default: 1000

Expected number of entries per page

string
sortBy
Optional

Sort the result based on any of the field

Possible values are : RESOURCE_NAME, POLICY_NAME, TITLE, START_TIME, END_TIME, EXECUTION_TIME, RESOURCE_TYPE, ASSIGNED_TO_TENANT,
string
sortOrder
Optional
Constraints: default: DESC

Sort Order for the results

Possible values are : ASC, DESC,
Request Body

The Billing Summary Request which supports sort, search and filter

bill-summary-request of type(s) application/json
Required 
"{\n  \"period\" : {\n    \"start\" : 1688149800000,\n    \"end\" : 1690482300000\n  },\n  \"searchCriterias\" : [ {\n    \"key\" : \"TITLE\",\n    \"value\" : \"Test Bill\"\n  } ]\n}"
object
period
Optional

Model to represent a date range param for searching bill summary

array of object
searchCriterias
Optional

The list of searchCriterias for getting bill summaries

Authentication
This operation uses the following authentication methods.
Responses
200

Bill Summary response

Returns metering-bill-summaries of type(s) application/json 
"{\n  \"meteringBillSummaries\" : [ {\n    \"billId\" : \"19fb38d5-2b02-41a5-a31e-7c2653f22fbd\",\n    \"title\" : \"TestBill\",\n    \"resourceType\" : \"REGION_QUOTA\",\n    \"resourceName\" : \"RegionQuota9\",\n    \"policyName\" : \"TestPolicy\",\n    \"totalPrice\" : 135.0,\n    \"billingTime\" : 1690821540334,\n    \"billingStartTime\" : 1687108240000,\n    \"billingEndTime\" : 1687108240000,\n    \"assignedToTenant\" : false\n  } ]\n}"
object
pageInfo
Optional

Represents page information for a paged result

array of object
links
Optional

Collection of links

array of object
meteringBillSummaries
Optional

List of bill summary


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/suite-api/api/chargeback/bills/query
On This Page
Chargeback Billing Operations
POST
Generate Bills
POST
Get Bill Summary
GET
Get Bill
DELETE
Delete Bill