Compound Aggregation Endpoints - m3ter Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

Use Compound Aggregations to create numerical measures from usage data by applying a calculation to one or more simple Aggregations or Custom Fields. These numerical measures can then be used as pricing metrics to price your Product Plans, enabling you to implement a wide range of usage-based pricing use cases.

Types of Compound Aggregation

You can create two types of Compound Aggregation:

Global

• Pricing: Not tied to any specific product and can be used to price Plans belonging to any Product.
• Calculation: can reference all simple Aggregations - both Global simple Aggregations and any product-specific simple Aggregations.

Product-specific

• Pricing: belong to a specific Product and can only be used to price Plans belonging to the same Product.
• Calculation: can reference any simple Aggregations belonging to the same Product and any Global simple Aggregations.

Notes and Warnings:

• Compound Aggregations based on Segmented Aggregations? You can use Compound Aggregations that reference Segmented Aggregations to price Plans. However, the segments made available to the Compound Aggregation for pricing a Plan will depend on whether a single or multiple Segmented Aggregations are referenced. See Pricing with Compound Aggregations Based on Segmented Aggregations for details. Any segments made available to a Compound Aggregation will be listed for the segments response parameter.
• Warning! If a simple Aggregation referenced by a Compound Aggregation has a Quantity per unit defined or a Rounding defined, these will not be factored into the value used by the calculation. For example, if the simple Aggregation referenced has a base value of 100 and has Quantity per unit set at 10, the Compound Aggregation calculation will use the base value of 100 not 10.

To better understand and use Compound Aggregations, refer to the example Compound Aggregation Use Case.