Metered Components

Learn how to create usage-based plans.

🚧

Recommended Reading: Creating Price Plans

A metered component identifies a meter and the corresponding consumption-based price. Metered components are the building blocks of usage-based price plans.

Usage

To create a metered component, you will need to identify a meter and it's associated prices. An example of a filled out metered component in the portal can be seen below.

1202

Definition

Field NameDescriptionTypeRequired
meter_nameThe meter identifier.StringRequired
price_schemeIf providing prices, what scheme type to use (see Pricing Scheme Types).EnumOptional.

Either (scheme_type and prices) OR price list must be provided.
pricesA list of prices and corresponding caps.List[Dict[String, Float]]Optional.

Either (scheme_type and prices) OR price list must be provided.
price_listThe price list identifier.StringOptional.

Either (scheme_type and prices) OR price list must be provided.
label_limitsThe limits to apply on the given metered component (see https://docs.getoctane.io/docs/label-limits)List[LabelLimit]Optional

📘

Uncapped Tiers

Notice how the cap field defines the ceiling of each price tier (inclusive). If cap is NULL or not provided, it will be treated as infinity (uncapped).


Next Steps

Learn more about price schemes or skip ahead!