--- title: List account product items slug: reference/list-account-product-items docTags: createdAt: 2025-03-18T18:28:02.913Z --- { "id": "onQjBg9AxqyPgHcAQ0daQ", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-items/list", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-items/list" } ], "name": "List account product items", "description": "

Retrieves all product items configured for your account's pricing structure.\nProduct items define the billable units and dimensions for your services that map usage events to charges.

\n

Use this endpoint to:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Returns array of all product items configured for the account with pricing dimensions", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "Billable service or feature within a product that connects to a meter for usage tracking and pricing calculations.", "customType": "payment.pricing.ProductItem.out[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the product item within the account.", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Identifier of the parent product that contains this billable item.", "example": "" }, { "name": "meterApiName", "kind": "optional", "type": "string", "description": "API name of the meter that tracks usage data for this product item.", "example": "" }, { "name": "dimensionLabelInfoList", "kind": "optional", "type": "array", "description": "List of dimension labels for categorizing usage data with custom names and grouping rules.", "modelRef": "#/components/schemas/payment.pricing.DimensionLabelInfo.out", "customType": "payment.pricing.DimensionLabelInfo.out[]", "schema": [ { "name": "groupInfo", "kind": "optional", "type": "object", "description": "Dimensional key-value pairs that define specific usage pattern or configuration attributes.", "modelRef": "#/components/schemas/payment.meters.GroupInfo.out", "customType": "payment.meters.GroupInfo.out", "schema": [ { "name": "gi", "kind": "optional", "type": "map", "description": "Group information key-value pairs used for meter categorization and aggregation purposes", "example": "", "customType": "map", "schema": [] } ] }, { "name": "label", "kind": "optional", "type": "string", "description": "Human-readable name associated with the dimensional grouping for display and identification purposes.", "example": "" } ] }, { "name": "productItemName", "kind": "optional", "type": "string", "description": "Human-readable name for the product item displayed in billing and reports.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Detailed description explaining what this product item represents and its billing purpose.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification status controlling whether the product item can be edited or deleted.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Timestamp in milliseconds when the product item configuration was last modified.", "example": 0 } ], "modelRef": "#/components/schemas/payment.pricing.ProductItem.out", "isExpanded": true } ] }, { "statusCode": "400", "description": "Invalid request parameters or malformed query", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Authentication required or invalid API key provided", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Insufficient permissions to access product item configuration", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "No product items found or account not properly configured", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal server error occurred while retrieving product items", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "l3BjeCymeFXq_BZMKtLNx", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-items/list \\\n --header 'accept: application/json'" }, { "id": "0UYUvaDx69gP3V3aE-2T3", "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/payments/pricing/amberflo/account-pricing/product-items/list\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "fzyd44aAsstMeyHJJL-4R", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-items/list\")\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": "ODtCmxw9pJUneXxSXNWCg", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/product-items/list\"\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": "l3BjeCymeFXq_BZMKtLNx" }, "results": { "languages": [ { "id": "JFcWmV_L_AhctsrfWbFgd", "language": "200", "code": "// Returns array of all product items configured for the account with pricing dimensions\n[\n {\n \"id\": \"\",\n \"productId\": \"\",\n \"meterApiName\": \"\",\n \"dimensionLabelInfoList\": [\n {\n \"groupInfo\": {\n \"gi\": \"\"\n },\n \"label\": \"\"\n }\n ],\n \"productItemName\": \"\",\n \"description\": \"\",\n \"lockingStatus\": \"\",\n \"lastUpdateTimeInMillis\": \"\"\n }\n]" }, { "id": "8XeGr_oNmS6LAFwN_M0RI", "language": "400", "code": "// Invalid request parameters or malformed query\n" }, { "id": "zG-9IsnKvB85XVAjrEJ-z", "language": "401", "code": "// Authentication required or invalid API key provided\n" }, { "id": "pXfp8kSlOeZ4YB2Hkrgo1", "language": "403", "code": "// Insufficient permissions to access product item configuration\n" }, { "id": "QT4y9lGY6x7blmDlKtx99", "language": "404", "code": "// No product items found or account not properly configured\n" }, { "id": "AIiYA4p-pkl0ieuQSqJg1", "language": "500", "code": "// Internal server error occurred while retrieving product items\n" } ], "selectedLanguageId": "JFcWmV_L_AhctsrfWbFgd" } }, "children": [ { "text": "" } ] }