Skip to content
Nexa Platform Docs

Get Cost Summary

GET
/api/v1/usage/cost-summary
curl --request GET \
  --url 'https://example.com/api/v1/usage/cost-summary?start_date=2026-04-15T12%3A00%3A00Z&end_date=2026-04-15T12%3A00%3A00Z'

Get overall cost summary for the specified period.

This endpoint provides a high-level summary of total credits consumed across all services and categories.

Args: start_date: Start date for summary end_date: End date for summary

Returns: CostSummary with aggregated cost data

Raises: HTTPException: If query fails

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
start_date
required
Start Date

Start date for summary

string format: date-time

Start date for summary

end_date
required
End Date

End date for summary

string format: date-time

End date for summary

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CostSummary

Cost summary model.

object
total_credits
required
Total Credits

Total credits consumed

number
compute_credits
required
Compute Credits

Compute credits

number
cloud_services_credits
required
Cloud Services Credits

Cloud services credits

number
storage_credits
Any of:
number
data_transfer_credits
Any of:
number
start_date
required
Start Date

Summary start date

string format: date-time
end_date
required
End Date

Summary end date

string format: date-time
Examplegenerated
{
  "total_credits": 1,
  "compute_credits": 1,
  "cloud_services_credits": 1,
  "storage_credits": 1,
  "data_transfer_credits": 1,
  "start_date": "2026-04-15T12:00:00Z",
  "end_date": "2026-04-15T12:00:00Z"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}