List meter price configurations with filters

1 min

GET

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

Retrieve paginated price configurations for Amberflo meters with support for temporal filtering and meter-specific queries. Returns pricing models including unit, volume, tiered, and group-based pricing configurations with their effective time periods and calculation models.

Query Parameters

limitinteger<int32>
Description
Maximum number of price configuration records to return per page for pagination control and response size management.
pageinteger<int32>
Description
Zero-based page number for paginated retrieval of price configuration records across multiple result sets.
meterApiNamesstring[]
Description
Filter results to include only price configurations for the specified Amberflo meter API names from meter definitions.
timeInSecondsinteger<int64>
Description
Filter for price configurations active at this specific point in time, in Unix time seconds for temporal pricing queries.
startTimeInSecondsinteger<int64>
Description
Filter for price configurations active after or at this inclusive start time boundary, in Unix time seconds.
endTimeInSecondsinteger<int64>
Description
Filter for price configurations active before this exclusive end time boundary, in Unix time seconds for temporal range filtering.

Responses

200Successful request

business_unit.pricing.configuration.query.MeterPriceConfigurationPage.out
Description
Paginated response containing meter price configurations with metadata for navigating large pricing configuration collections and temporal filtering results.
- metadatabusiness_unit.pricing.configuration.query.MeterPriceConfigurationPageMetadata.out
  Description
  Pagination control metadata including page size, current position, meter filters applied, and result counts for price configurations.
  - limitinteger<int32>
    Description
    Maximum number of meter price configuration records per page. Controls pagination size for efficient pricing data retrieval and display.
  - pageinteger<int32>
    Description
    Zero-based current page number in meter price configuration results. Used for pagination navigation through large pricing configuration collections.
  - meterApiNamesstring[]
    Description
    Applied meter API name filter for price configurations. Shows which Amberflo meters are included in current result set.
  - timeInSecondsinteger<int64>
    Description
    Applied time filter for configurations active at specific point. Shows Unix timestamp used for temporal pricing configuration filtering.
  - startTimeInSecondsinteger<int64>
    Description
    Applied inclusive start time boundary for configuration activity filtering. Shows earliest time used in temporal query range.
  - endTimeInSecondsinteger<int64>
    Description
    Applied exclusive end time boundary for configuration activity filtering. Shows latest time used in temporal query range.
  - totalRowCountinteger<int32>
    Description
    Total number of meter price configurations across all pages. Represents complete pricing configuration dataset size without pagination.
  - filteredRowCountinteger<int32>
    Description
    Number of meter price configurations matching applied filters. Represents filtered pricing configuration set size before pagination.
  - totalFilteredPagesinteger<int32>
    Description
    Total pages available for filtered meter price configuration results. Used for pagination controls and navigation through pricing data.
- itemsbusiness_unit.pricing.configuration.MeterPriceConfiguration.out[]
  Description
  Array of meter price configuration definitions for current page. Contains complete pricing models with effective time periods and calculation logic.
  - 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[]
        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)
        Max depth limit reached
    - business_unit.pricing.generator.GroupUnitPriceGenerator.out
      - 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 GET \
     --url https://app.amberflo.io/business-unit/meter/price \
     --header 'accept: application/json'

javascript

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

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   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::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

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

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Successful request
{
  "metadata": {
    "limit": "",
    "page": "",
    "meterApiNames": [
      ""
    ],
    "timeInSeconds": "",
    "startTimeInSeconds": "",
    "endTimeInSeconds": "",
    "totalRowCount": "",
    "filteredRowCount": "",
    "totalFilteredPages": ""
  },
  "items": [
    {
      "meterApiName": "",
      "label": "",
      "description": "",
      "model": {},
      "startTimeInSeconds": "",
      "endTimeInSeconds": "",
      "createTimeInMillis": "",
      "updateTimeInMillis": ""
    }
  ]
}