v1

latestOpenAPI 3.1.02026-07-222392081.7 MB

Aggregators

Update aggregator

Update the details of an existing aggregator.

put/v1/aggregators/{id}

idstring required

entitystring

The billable event entity to aggregate.

type'metered' | 'licensed'

The type of aggregator.

namestring

Name of the aggregator.

descriptionstring nullable

Description of the aggregator.

allow_negative_valuesboolean

Whether the aggregator can produce negative values.

aggregate_on_customers_enabledboolean

Whether the aggregator should aggregate on customers.

custom_event_namestring

Custom event name for the aggregator.

exposed_event_keysstring[]

Event keys exposed by the aggregator.

unit_namestring nullable

Display name of the unit being measured (e.g. 'user', 'request'). Used as fallback for products attached to this aggregator.

default_interval_countinteger

Default interval count for usage periods.

default_interval_period'days' | 'weeks' | 'months' | 'years'

Default interval period for usage periods.

formula_sqlstring

Read-only formula expression; not accepted on public writes.

operation'count' | 'sum'

The aggregation operation to perform.

propertystring

The property to sum. Required when operation is 'sum'.

{
  "entity": "api_calls",
  "unit_name": "user"
}