---
title: List meter price configurations with filters
slug: reference/list-meter-price-configurations-with-filters
docTags:
createdAt: 2025-07-03T16:20:35.017Z
---
{
"id": "mnXGlJxZOP8al3r37_qIC",
"type": "api-oas-v2",
"data": {
"method": "GET",
"url": "https://app.amberflo.io/business-unit/meter/price",
"servers": [
{
"url": "https://app.amberflo.io/business-unit/meter/price"
}
],
"name": "List meter price configurations with filters",
"description": "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.
",
"contentType": "application/json",
"request": {
"pathParameters": [],
"headerParameters": [],
"queryParameters": [
{
"kind": "optional",
"name": "limit",
"type": "integer",
"description": "Maximum number of price configuration records to return per page for pagination control and response size management."
},
{
"kind": "optional",
"name": "page",
"type": "integer",
"description": "Zero-based page number for paginated retrieval of price configuration records across multiple result sets.
"
},
{
"kind": "optional",
"name": "meterApiNames",
"type": "array",
"description": "Filter results to include only price configurations for the specified Amberflo meter API names from meter definitions.",
"schema": [],
"itemType": "string",
"customType": "string[]"
},
{
"kind": "optional",
"name": "timeInSeconds",
"type": "integer",
"description": "Filter for price configurations active at this specific point in time, in Unix time seconds for temporal pricing queries.
"
},
{
"kind": "optional",
"name": "startTimeInSeconds",
"type": "integer",
"description": "Filter for price configurations active after or at this inclusive start time boundary, in Unix time seconds.
"
},
{
"kind": "optional",
"name": "endTimeInSeconds",
"type": "integer",
"description": "Filter for price configurations active before this exclusive end time boundary, in Unix time seconds for temporal range filtering.
"
}
],
"bodyDataParameters": [],
"formDataParameters": [],
"oAuthParameters": [
{
"id": "apiKey",
"name": "X-API-KEY",
"kind": "optional",
"type": "apiKey",
"in": "header"
}
]
},
"responses": [
{
"statusCode": "200",
"description": "Successful request",
"jsonExample": "",
"isExpanded": true,
"schema": [
{
"kind": "optional",
"type": "object",
"description": "Paginated response containing meter price configurations with metadata for navigating large pricing configuration collections and temporal filtering results.",
"customType": "business_unit.pricing.configuration.query.MeterPriceConfigurationPage.out",
"schema": [
{
"name": "metadata",
"kind": "optional",
"type": "object",
"description": "Pagination control metadata including page size, current position, meter filters applied, and result counts for price configurations.",
"modelRef": "#/components/schemas/business_unit.pricing.configuration.query.MeterPriceConfigurationPageMetadata.out",
"customType": "business_unit.pricing.configuration.query.MeterPriceConfigurationPageMetadata.out",
"schema": [
{
"name": "limit",
"kind": "optional",
"type": "integer",
"description": "Maximum number of meter price configuration records per page. Controls pagination size for efficient pricing data retrieval and display.",
"example": 0
},
{
"name": "page",
"kind": "optional",
"type": "integer",
"description": "Zero-based current page number in meter price configuration results. Used for pagination navigation through large pricing configuration collections.",
"example": 0
},
{
"name": "meterApiNames",
"kind": "optional",
"type": "array",
"description": "Applied meter API name filter for price configurations. Shows which Amberflo meters are included in current result set.",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "timeInSeconds",
"kind": "optional",
"type": "integer",
"description": "Applied time filter for configurations active at specific point. Shows Unix timestamp used for temporal pricing configuration filtering.",
"example": 0
},
{
"name": "startTimeInSeconds",
"kind": "optional",
"type": "integer",
"description": "Applied inclusive start time boundary for configuration activity filtering. Shows earliest time used in temporal query range.",
"example": 0
},
{
"name": "endTimeInSeconds",
"kind": "optional",
"type": "integer",
"description": "Applied exclusive end time boundary for configuration activity filtering. Shows latest time used in temporal query range.",
"example": 0
},
{
"name": "totalRowCount",
"kind": "optional",
"type": "integer",
"description": "Total number of meter price configurations across all pages. Represents complete pricing configuration dataset size without pagination.",
"example": 0
},
{
"name": "filteredRowCount",
"kind": "optional",
"type": "integer",
"description": "Number of meter price configurations matching applied filters. Represents filtered pricing configuration set size before pagination.",
"example": 0
},
{
"name": "totalFilteredPages",
"kind": "optional",
"type": "integer",
"description": "Total pages available for filtered meter price configuration results. Used for pagination controls and navigation through pricing data.",
"example": 0
}
]
},
{
"name": "items",
"kind": "optional",
"type": "array",
"description": "Array of meter price configuration definitions for current page. Contains complete pricing models with effective time periods and calculation logic.",
"modelRef": "#/components/schemas/business_unit.pricing.configuration.MeterPriceConfiguration.out",
"customType": "business_unit.pricing.configuration.MeterPriceConfiguration.out[]",
"schema": [
{
"name": "meterApiName",
"kind": "required",
"type": "string",
"description": "Amberflo meter API identifier from Meter API definitions. Specifies which meter this price configuration applies to for usage calculations.",
"example": ""
},
{
"name": "label",
"kind": "required",
"type": "string",
"description": "Human-readable display name for price configuration management. Used for administrative identification and organizational purposes in pricing setup.",
"example": ""
},
{
"name": "description",
"kind": "optional",
"type": "string",
"description": "Detailed explanation of price configuration purpose and calculation logic. Provides context for pricing model application and business unit cost assignment.",
"example": ""
},
{
"name": "model",
"kind": "required",
"type": "object",
"description": "Pricing calculation model defining cost computation logic. Supports unit, volume, tiered, and group-based pricing structures for usage-based billing.",
"modelRef": "#/components/schemas/business_unit.pricing.generator.PriceMachineGenerator.out",
"customType": "business_unit.pricing.generator.PriceMachineGenerator.out",
"schema": [],
"complexType": "oneOf",
"complexItems": [
{
"name": "business_unit.pricing.generator.BlockPriceGenerator.out",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.BlockPriceGenerator.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"example": "",
"default": "block"
},
{
"name": "size",
"kind": "optional",
"type": "integer",
"description": "",
"example": 0
},
{
"name": "price",
"kind": "optional",
"type": "number",
"description": "",
"example": ""
},
{
"name": "blockUseMode",
"kind": "optional",
"type": "string",
"description": "Billing behavior for fractional block usage when consumption doesn't align with block size boundaries.\n\n**Values:**\n- **FULL:** Charge complete block price for any partial block usage (round up billing)\n- **PARTIAL:** Charge proportional price based on actual usage within the block (exact billing)\n",
"modelRef": "#/components/schemas/business_unit.pricing.machine.BlockUseMode.out",
"customType": "business_unit.pricing.machine.BlockUseMode.out",
"schema": []
}
]
},
{
"name": "business_unit.pricing.generator.GroupBlockPriceGenerator.out",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.GroupBlockPriceGenerator.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"example": "",
"default": "group_block"
},
{
"name": "dimensionKeys",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "priceTable",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.GroupBlockPriceGenerator.Row.out",
"customType": "business_unit.pricing.generator.GroupBlockPriceGenerator.Row.out[]",
"schema": [
{
"name": "dimensionValues",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "size",
"kind": "optional",
"type": "integer",
"description": "",
"example": 0
},
{
"name": "price",
"kind": "optional",
"type": "number",
"description": "",
"example": ""
}
]
},
{
"name": "blockUseMode",
"kind": "optional",
"type": "string",
"description": "Billing behavior for fractional block usage when consumption doesn't align with block size boundaries.\n\n**Values:**\n- **FULL:** Charge complete block price for any partial block usage (round up billing)\n- **PARTIAL:** Charge proportional price based on actual usage within the block (exact billing)\n",
"modelRef": "#/components/schemas/business_unit.pricing.machine.BlockUseMode.out",
"customType": "business_unit.pricing.machine.BlockUseMode.out",
"schema": []
}
]
},
{
"name": "business_unit.pricing.generator.GroupTieredPriceGenerator.out",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.GroupTieredPriceGenerator.out",
"schema": [
{
"name": "type",
"kind": "optional",
"type": "string",
"description": "",
"example": "",
"default": "group_tiered"
},
{
"name": "dimensionKeys",
"kind": "optional",
"type": "array",
"description": "",
"example": "",
"itemType": "string",
"customType": "string[]",
"itemExample": "",
"itemDefault": ""
},
{
"name": "priceTable",
"kind": "optional",
"type": "array",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.GroupTieredPriceGenerator.Row.out",
"customType": "business_unit.pricing.generator.GroupTieredPriceGenerator.Row.out[]",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "blockUseMode",
"kind": "optional",
"type": "string",
"description": "Billing behavior for fractional block usage when consumption doesn't align with block size boundaries.\n\n**Values:**\n- **FULL:** Charge complete block price for any partial block usage (round up billing)\n- **PARTIAL:** Charge proportional price based on actual usage within the block (exact billing)\n",
"modelRef": "#/components/schemas/business_unit.pricing.machine.BlockUseMode.out",
"customType": "business_unit.pricing.machine.BlockUseMode.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "business_unit.pricing.generator.GroupUnitPriceGenerator.out",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.GroupUnitPriceGenerator.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "business_unit.pricing.generator.GroupVolumePriceGenerator.out",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.GroupVolumePriceGenerator.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "business_unit.pricing.generator.TieredPriceGenerator.out",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.TieredPriceGenerator.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "business_unit.pricing.generator.UnitPriceGenerator.out",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.UnitPriceGenerator.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
},
{
"name": "business_unit.pricing.generator.VolumePriceGenerator.out",
"description": "",
"modelRef": "#/components/schemas/business_unit.pricing.generator.VolumePriceGenerator.out",
"schema": [
{
"name": "",
"description": "",
"customType": "Max depth limit reached"
}
]
}
]
},
{
"name": "startTimeInSeconds",
"kind": "required",
"type": "integer",
"description": "Configuration activation timestamp in Unix seconds format. Defines when price configuration becomes effective for meter usage calculations.",
"example": 0
},
{
"name": "endTimeInSeconds",
"kind": "optional",
"type": "integer",
"description": "Optional configuration expiration timestamp in Unix seconds format. When not set, configuration applies until next version starts. Used for explicit period termination.",
"example": 0
},
{
"name": "createTimeInMillis",
"kind": "optional",
"type": "integer",
"description": "Configuration creation timestamp in Unix milliseconds format. Tracks when meter price configuration was first established in system.",
"example": 0
},
{
"name": "updateTimeInMillis",
"kind": "optional",
"type": "integer",
"description": "Configuration modification timestamp in Unix milliseconds format. Tracks when meter price configuration was last changed or updated.",
"example": 0
}
]
}
],
"modelRef": "#/components/schemas/business_unit.pricing.configuration.query.MeterPriceConfigurationPage.out",
"isExpanded": true
}
]
}
],
"hasXCodeSamples": false,
"examples": {
"languages": [
{
"id": "jMDTcOd5pWK_113EMv8Ga",
"language": "curl",
"label": "cURL",
"code": "curl --request GET \\\n --url https://app.amberflo.io/business-unit/meter/price \\\n --header 'accept: application/json'"
},
{
"id": "zfCGLZRWSf68UJxk-nHK6",
"language": "javascript",
"label": "javascript",
"code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/business-unit/meter/price\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
},
{
"id": "WfJrbEjEh6I5UStMh5Qgh",
"language": "ruby",
"label": "Ruby",
"code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/business-unit/meter/price\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
},
{
"id": "T9Xh8QHk9htu5QUZS_Gk7",
"language": "python",
"label": "Python",
"code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/business-unit/meter/price\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
],
"selectedLanguageId": "jMDTcOd5pWK_113EMv8Ga"
},
"results": {
"languages": [
{
"id": "response-0-200",
"language": "200",
"code": "// Successful request\n{\n \"metadata\": {\n \"limit\": \"\",\n \"page\": \"\",\n \"meterApiNames\": [\n \"\"\n ],\n \"timeInSeconds\": \"\",\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"totalRowCount\": \"\",\n \"filteredRowCount\": \"\",\n \"totalFilteredPages\": \"\"\n },\n \"items\": [\n {\n \"meterApiName\": \"\",\n \"label\": \"\",\n \"description\": \"\",\n \"model\": {},\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\",\n \"createTimeInMillis\": \"\",\n \"updateTimeInMillis\": \"\"\n }\n ]\n}"
}
],
"selectedLanguageId": "response-0-200"
}
},
"children": [
{
"text": "",
"id": "aedeXDV25Z-AWaweciS0g"
}
]
}