Create pricing model for Amberflo meter

1 min

POST

https://app.amberflo.io/business-unit/meter/price

Create a new price configuration for an Amberflo meter to define how usage should be calculated and charged. Supports multiple pricing models including unit pricing, volume pricing with tiers, tiered pricing structures, and group-based pricing with dimension tables for accurate cost allocation to business units.

Body Parameters

bodybusiness_unit.pricing.configuration.MeterPriceConfiguration.in
Description
Input model for creating meter price configurations that define how Amberflo meter usage is calculated and charged for accurate business unit cost allocation.
- meterApiNamestringrequired
  Description
  Amberflo meter API identifier from Meter API definitions. Specifies which meter this price configuration applies to for usage calculations.
- labelstringrequired
  Description
  Human-readable display name for price configuration management. Used for administrative identification and organizational purposes in pricing setup.
- descriptionstring
  Description
  Detailed explanation of price configuration purpose and calculation logic. Provides context for pricing model application and business unit cost assignment.
- modelbusiness_unit.pricing.generator.PriceMachineGenerator.inrequired
  Description
  Pricing calculation model defining cost computation logic. Supports unit, volume, tiered, and group-based pricing structures for usage-based billing.
  - business_unit.pricing.generator.BlockPriceGenerator.in
    - typestring
      Description
      Pricing model type identifier for block-based billing structure. **Fixed value:** Always "block" for block-based pricing with fixed block sizes.
      Default
      block
    - sizeinteger<int64>
      Description
      Number of usage units that comprise one billable block for pricing calculations. **Example:** Size of 100 means usage is billed in increments of 100 units per block.
    - pricenumber
      Description
      Cost per block of usage in account currency regardless of partial usage within block. **Important:** This price applies to each complete block, with fractional blocks handled per blockUseMode.
    - blockUseModebusiness_unit.pricing.machine.BlockUseMode.in
      Description
      Controls how partial blocks are priced when usage doesn't align with block boundaries. **Options:** FULL (charge full block price) or PARTIAL (charge proportionally).
  - business_unit.pricing.generator.GroupBlockPriceGenerator.in
    - typestring
      Description
      Pricing model type identifier for dimension-based block pricing with variable rates per group. **Fixed value:** Always "group_block" for dimension-grouped block pricing models.
      Default
      group_block
    - dimensionKeysstring[]
      Description
      Ordered array of dimension names that define the grouping structure for block pricing variations. **Example:** ["region", "instance_type"] creates pricing groups based on region and instance type combinations.
    - priceTablebusiness_unit.pricing.generator.GroupBlockPriceGenerator.Row.in[]
      Description
      Array of pricing rows defining specific dimension value combinations and their corresponding block pricing configuration. **Structure:** Each row maps dimension values to block size and price for that combination.
      - dimensionValuesstring[]
      - sizeinteger<int64>
      - pricenumber
    - blockUseModebusiness_unit.pricing.machine.BlockUseMode.in
      Description
      Controls how partial blocks are priced when usage doesn't align with block boundaries across all groups. **Application:** Applied consistently across all dimension-based pricing groups.
  - business_unit.pricing.generator.GroupTieredPriceGenerator.in
    - typestring
      Description
      Pricing model type identifier for dimension-based tiered pricing with progressive rates per group. **Fixed value:** Always "group_tiered" for dimension-grouped tiered pricing models.
      Default
      group_tiered
    - dimensionKeysstring[]
      Description
      Ordered array of dimension names that define the grouping structure for tiered pricing variations. **Example:** ["region", "service_level"] creates tier structures based on region and service level combinations.
    - priceTablebusiness_unit.pricing.generator.GroupTieredPriceGenerator.Row.in[]
      Description
      Array of pricing rows defining specific dimension value combinations and their corresponding tier pricing structures. **Structure:** Each row maps dimension values to tier configurations for progressive billing within that group.
      - dimensionValuesstring[]
      - tiersbusiness_unit.pricing.machine.PriceTier.in[]
        Description
        **Pricing tier definition for tiered and volume billing models** **Important note:** Defines usage range boundaries and pricing for progressive billing structures **Technical details:** - Used in TieredPriceGenerator and VolumePriceGenerator for usage-based pricing - Supports progressive pricing where different usage ranges have different rates - Block-based calculation allows for bulk pricing within tier boundaries **Constraint:** startAfterUnit must be less than or equal to next tier's startAfterUnit
        Max depth limit reached
    - blockUseModebusiness_unit.pricing.machine.BlockUseMode.in
      Description
      Controls how partial blocks within tiers are priced across all dimension-based pricing groups. **Application:** Applied to fractional blocks in each tier calculation for every group combination.
  - business_unit.pricing.generator.GroupUnitPriceGenerator.in
    - typestring
      Description
      Pricing model type identifier for dimension-based unit pricing with variable rates per group. **Fixed value:** Always "group_unit" for dimension-grouped unit pricing models.
      Default
      group_unit
    - dimensionKeysstring[]required
      Description
      The names (or keys) of the dimensions that form the price table.
    - priceTablebusiness_unit.pricing.generator.GroupUnitPriceGenerator.Row.in[]required
      Description
      Allows specifying different prices for different combinations of dimension values.
      - Max depth limit reached
    - blockUseModebusiness_unit.pricing.machine.BlockUseMode.in
      Description
      Specifies how fractional usage is priced: - `PARTIAL` means that a fraction of a unit of usage is proportionally priced. - `FULL` means that a fraction of a unit of usage is priced the same as a whole unit of usage.
      - Max depth limit reached
  - business_unit.pricing.generator.GroupVolumePriceGenerator.in
    - Max depth limit reached
  - business_unit.pricing.generator.TieredPriceGenerator.in
    - Max depth limit reached
  - business_unit.pricing.generator.UnitPriceGenerator.in
    - Max depth limit reached
  - business_unit.pricing.generator.VolumePriceGenerator.in
    - Max depth limit reached
- startTimeInSecondsinteger<int64>required
  Description
  Configuration activation timestamp in Unix seconds format. Defines when price configuration becomes effective for meter usage calculations.
- endTimeInSecondsinteger<int64>
  Description
  Optional configuration expiration timestamp in Unix seconds format. When not set, configuration applies until next version starts. Used for explicit period termination.

Responses

200Successful request

business_unit.pricing.configuration.MeterPriceConfiguration.out
Description
Complete meter price configuration with system metadata defining how Amberflo meter usage is calculated and charged for accurate business unit cost allocation.
- meterApiNamestringrequired
  Description
  Amberflo meter API identifier from Meter API definitions. Specifies which meter this price configuration applies to for usage calculations.
- labelstringrequired
  Description
  Human-readable display name for price configuration management. Used for administrative identification and organizational purposes in pricing setup.
- descriptionstring
  Description
  Detailed explanation of price configuration purpose and calculation logic. Provides context for pricing model application and business unit cost assignment.
- modelbusiness_unit.pricing.generator.PriceMachineGenerator.outrequired
  Description
  Pricing calculation model defining cost computation logic. Supports unit, volume, tiered, and group-based pricing structures for usage-based billing.
  - business_unit.pricing.generator.BlockPriceGenerator.out
    - typestring
      Default
      block
    - sizeinteger<int64>
    - pricenumber
    - blockUseModebusiness_unit.pricing.machine.BlockUseMode.out
      Description
      Billing behavior for fractional block usage when consumption doesn't align with block size boundaries. **Values:** - **FULL:** Charge complete block price for any partial block usage (round up billing) - **PARTIAL:** Charge proportional price based on actual usage within the block (exact billing)
  - business_unit.pricing.generator.GroupBlockPriceGenerator.out
    - typestring
      Default
      group_block
    - dimensionKeysstring[]
    - priceTablebusiness_unit.pricing.generator.GroupBlockPriceGenerator.Row.out[]
      - dimensionValuesstring[]
      - sizeinteger<int64>
      - pricenumber
    - blockUseModebusiness_unit.pricing.machine.BlockUseMode.out
      Description
      Billing behavior for fractional block usage when consumption doesn't align with block size boundaries. **Values:** - **FULL:** Charge complete block price for any partial block usage (round up billing) - **PARTIAL:** Charge proportional price based on actual usage within the block (exact billing)
  - business_unit.pricing.generator.GroupTieredPriceGenerator.out
    - typestring
      Default
      group_tiered
    - dimensionKeysstring[]
    - priceTablebusiness_unit.pricing.generator.GroupTieredPriceGenerator.Row.out[]
      - dimensionValuesstring[]
      - tiersbusiness_unit.pricing.machine.PriceTier.out[]
        Description
        **Pricing tier definition for tiered and volume billing models** **Important note:** Defines usage range boundaries and pricing for progressive billing structures **Technical details:** - Used in TieredPriceGenerator and VolumePriceGenerator for usage-based pricing - Supports progressive pricing where different usage ranges have different rates - Block-based calculation allows for bulk pricing within tier boundaries **Constraint:** startAfterUnit must be less than or equal to next tier's startAfterUnit
        Max depth limit reached
    - blockUseModebusiness_unit.pricing.machine.BlockUseMode.out
      Description
      Billing behavior for fractional block usage when consumption doesn't align with block size boundaries. **Values:** - **FULL:** Charge complete block price for any partial block usage (round up billing) - **PARTIAL:** Charge proportional price based on actual usage within the block (exact billing)
  - business_unit.pricing.generator.GroupUnitPriceGenerator.out
    - typestring
      Default
      group_unit
    - dimensionKeysstring[]required
      Description
      The names (or keys) of the dimensions that form the price table.
    - priceTablebusiness_unit.pricing.generator.GroupUnitPriceGenerator.Row.out[]required
      Description
      Allows specifying different prices for different combinations of dimension values.
      - Max depth limit reached
    - blockUseModebusiness_unit.pricing.machine.BlockUseMode.out
      Description
      Specifies how fractional usage is priced: - `PARTIAL` means that a fraction of a unit of usage is proportionally priced. - `FULL` means that a fraction of a unit of usage is priced the same as a whole unit of usage.
      - Max depth limit reached
  - business_unit.pricing.generator.GroupVolumePriceGenerator.out
    - Max depth limit reached
  - business_unit.pricing.generator.TieredPriceGenerator.out
    - Max depth limit reached
  - business_unit.pricing.generator.UnitPriceGenerator.out
    - Max depth limit reached
  - business_unit.pricing.generator.VolumePriceGenerator.out
    - Max depth limit reached
- startTimeInSecondsinteger<int64>required
  Description
  Configuration activation timestamp in Unix seconds format. Defines when price configuration becomes effective for meter usage calculations.
- endTimeInSecondsinteger<int64>
  Description
  Optional configuration expiration timestamp in Unix seconds format. When not set, configuration applies until next version starts. Used for explicit period termination.
- createTimeInMillisinteger<int64>
  Description
  Configuration creation timestamp in Unix milliseconds format. Tracks when meter price configuration was first established in system.
- updateTimeInMillisinteger<int64>
  Description
  Configuration modification timestamp in Unix milliseconds format. Tracks when meter price configuration was last changed or updated.

curl

curl --request POST \
     --url https://app.amberflo.io/business-unit/meter/price \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "meterApiName": "",
     "label": "",
     "model": {
     "type": "block"
     },
     "startTimeInSeconds": 0
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "meterApiName": "",
   "label": "",
   "model": {
      "type": "block"
   },
   "startTimeInSeconds": 0
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/business-unit/meter/price", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/business-unit/meter/price")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "meterApiName": "",
   "label": "",
   "model": {
      "type": "block"
   },
   "startTimeInSeconds": 0
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/business-unit/meter/price"

payload = json.dumps({
   "meterApiName": "",
   "label": "",
   "model": {
      "type": "block"
   },
   "startTimeInSeconds": 0
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "meterApiName": "",
  "label": "",
  "description": "",
  "model": {},
  "startTimeInSeconds": "",
  "endTimeInSeconds": "",
  "createTimeInMillis": "",
  "updateTimeInMillis": ""
}