getAggregateEstimates
getAggregateEstimatesRetrieve billable metric estimates for a customer over a date range. Specify the aggregate ID and customer ID to get usage estimates.
Instructions
Get Billable Metric estimates based on the specified criteria.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aggregate_id | Yes | The ID of the Billable Metric (aggregate). | |
| customer_id | Yes | The ID of the customer. | |
| start_date | Yes | Start date of the estimate window. ISO 8601 date format only — YYYY-MM-DD (e.g., '2025-01-15'). NOT datetime. | |
| end_date | Yes | End date of the estimate window. ISO 8601 date format only — YYYY-MM-DD (e.g., '2025-01-31'). NOT datetime. | |
| get_single | No | Whether to get a single estimate (defaults to true). | |
| __userContext | No | Internal user context for multi-tenant authentication and approval workflow |