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.
Definition
| Field Name | Description | Type | Required |
|---|---|---|---|
| meter_name | The meter identifier. | String | Required |
| price_scheme | If providing prices, what scheme type to use (see Pricing Scheme Types). | Enum | Optional. Either (scheme_type and prices) OR price list must be provided. |
| prices | A list of prices and corresponding caps. | List[Dict[String, Float]] | Optional. Either (scheme_type and prices) OR price list must be provided. |
| price_list | The price list identifier. | String | Optional. Either (scheme_type and prices) OR price list must be provided. |
| label_limits | The 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).
Updated about 1 year ago