API Reference
Log In
API Reference

Get Cost By Credential

Retrieve cost metrics by subscriber credential over time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Unique identifier of the team (organization). Format: Revenium hashid (URL-safe encoded string).

string
enum

Predefined time window to aggregate results (e.g., TWELVE_MONTHS). Ignored if both startDate and endDate are provided. Defaults to TWELVE_MONTHS when no custom date range is specified.

Allowed:
string
enum
required

Aggregation group for the metric.

Allowed:
string

Start of a custom date range in ISO 8601 format (e.g., 2025-09-01T00:00:00Z). Must be provided together with endDate. When both are provided, the period parameter is ignored and this custom range is used instead.

string

End of a custom date range in ISO 8601 format (e.g., 2025-09-30T23:59:59Z). Must be provided together with startDate. When both are provided, the period parameter is ignored and this custom range is used instead.

credentials
array of strings

Optional list of subscriber credential identifiers to include. Omit to include all credentials.

credentials
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*