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

Retrieves comprehensive account pricing configuration including all product plans, items, and associated pricing details.\nUse this endpoint to get a complete view of your billing cloud setup in a single request.

\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 complete account pricing configuration including all product plans, items, and pricing details", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Comprehensive account-level pricing configuration containing products, cost plans, promotions, prepaid offers, currency exchange rates, and account settings for billing operations.", "customType": "payment.pricing.AccountPricing.out", "schema": [ { "name": "products", "kind": "optional", "type": "map", "description": "Map of all products offered by the account, containing product definitions and billing configurations.", "example": "", "customType": "map", "schema": [] }, { "name": "productItemPricesMap", "kind": "optional", "type": "map", "description": "Map of pricing configurations for individual product items, defining cost structures and billing rules.", "example": "", "customType": "map", "schema": [] }, { "name": "costPlan", "kind": "optional", "type": "object", "description": "Usage-based cost plan containing pricing generators and billing rules for metered consumption.", "modelRef": "#/components/schemas/payment.pricing.cost.CostPlan.out", "customType": "payment.pricing.cost.CostPlan.out", "schema": [ { "name": "meterStartDateCostItemMap", "kind": "optional", "type": "map", "description": "Nested map from meter API names to start dates (seconds) to cost item price generators for temporal pricing organization.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "productItemRewardsRulesMap", "kind": "optional", "type": "map", "description": "Map of reward rules for product items, defining loyalty programs and incentive structures.", "example": "", "customType": "map", "schema": [] }, { "name": "productPlansMap", "kind": "optional", "type": "map", "description": "Map of product-specific plan configurations containing subscription options and pricing tiers.", "example": "", "customType": "map", "schema": [] }, { "name": "promotionMap", "kind": "optional", "type": "map", "description": "Map of active promotions and discounts available for account products and services.", "example": "", "customType": "map", "schema": [] }, { "name": "prepaidOfferMap", "kind": "optional", "type": "map", "description": "Map of prepaid credit offers and packages available for customer purchase and consumption.", "example": "", "customType": "map", "schema": [] }, { "name": "currenciesExchangeRatesMap", "kind": "optional", "type": "map", "description": "Map of currency exchange rates for multi-currency billing and international payment processing.", "example": "", "customType": "map", "schema": [] }, { "name": "creditUnit", "kind": "optional", "type": "object", "description": "Account credit unit definition specifying the base unit for prepaid credits and billing calculations.", "modelRef": "#/components/schemas/payment.pricing.CreditUnit.out", "customType": "payment.pricing.CreditUnit.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for this credit unit configuration within the account", "example": "" }, { "name": "shortName", "kind": "optional", "type": "string", "description": "Abbreviated name for credit unit used in compact displays and reports", "example": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "Full descriptive name for credit unit displayed to customers and administrators", "example": "" }, { "name": "ratioToCurrency", "kind": "optional", "type": "number", "description": "Exchange rate defining amount of account currency per credit unit for conversions", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Detailed explanation of credit unit purpose and usage for customer understanding", "example": "" }, { "name": "active", "kind": "optional", "type": "boolean", "description": "Whether this credit unit configuration is currently enabled for billing operations", "example": "" }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when credit unit configuration was last modified", "example": 0 } ] }, { "name": "accountPricingSettings", "kind": "optional", "type": "object", "description": "Account-level pricing configuration settings controlling billing behavior and payment processing rules.", "modelRef": "#/components/schemas/payment.pricing.AccountPricingSettings.out", "customType": "payment.pricing.AccountPricingSettings.out", "schema": [ { "name": "planDefaultStartUnit", "kind": "optional", "type": "string", "description": "Default time unit configuration for when new pricing plans become active for customers.", "modelRef": "#/components/schemas/payment.pricing.PlanDefaultStartUnit.in", "customType": "payment.pricing.PlanDefaultStartUnit.in", "schema": [] } ] }, { "name": "accountDetails", "kind": "optional", "type": "object", "description": "Account metadata and configuration details including company information and billing preferences.", "modelRef": "#/components/schemas/payment.pricing.AccountDetails.out", "customType": "payment.pricing.AccountDetails.out", "schema": [ { "name": "baseCurrency", "kind": "optional", "type": "string", "description": "The base or local currency for the account.", "example": "USD" } ] }, { "name": "productInvoiceFeesMap", "kind": "optional", "type": "map", "description": "Map of invoice-based fee configurations for products, defining fixed charges and recurring fees.", "example": "", "customType": "map", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Timestamp in milliseconds when the account pricing configuration was last modified.", "example": 0 }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current locking status controlling whether the pricing configuration can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "accountId", "kind": "optional", "type": "string", "description": "Unique identifier for the account that owns this pricing configuration.", "example": "" }, { "name": "approvalRuleMap", "kind": "optional", "type": "map", "description": "Map of approval rules governing pricing changes and promotional offer validations.", "example": "", "customType": "map", "schema": [] }, { "name": "prepaidPromotions", "kind": "optional", "type": "map", "description": "Map of prepaid credit promotions offering bonus credits and purchase incentives.", "example": "", "customType": "map", "schema": [] }, { "name": "planCatalogs", "kind": "optional", "type": "map", "description": "Map of plan catalogs containing standardized pricing templates and subscription options.", "example": "", "customType": "map", "schema": [] }, { "name": "usageTransformersMap", "kind": "optional", "type": "map", "description": "Map of usage transformers defining custom aggregation rules and billing calculations.", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/payment.pricing.AccountPricing.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 account pricing configuration", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Account pricing configuration not found or not properly set up", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal server error occurred while retrieving pricing data", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "UMF6V2vsmfEOUGRd-emQx", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing \\\n --header 'accept: application/json'" }, { "id": "SdotlpODeIFNJimKhhyLD", "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\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "N1_BfOA3M226iiezWphj4", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/account-pricing\")\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": "siffenSJHoo-OzH2cZdmX", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/account-pricing\"\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": "UMF6V2vsmfEOUGRd-emQx" }, "results": { "languages": [ { "id": "6htDtDhf5lKlPYuxzsT9t", "language": "200", "code": "// Returns complete account pricing configuration including all product plans, items, and pricing details\n{\n \"products\": \"\",\n \"productItemPricesMap\": \"\",\n \"costPlan\": {\n \"meterStartDateCostItemMap\": \"\"\n },\n \"productItemRewardsRulesMap\": \"\",\n \"productPlansMap\": \"\",\n \"promotionMap\": \"\",\n \"prepaidOfferMap\": \"\",\n \"currenciesExchangeRatesMap\": \"\",\n \"creditUnit\": {\n \"id\": \"\",\n \"shortName\": \"\",\n \"name\": \"\",\n \"ratioToCurrency\": 0,\n \"description\": \"\",\n \"active\": false,\n \"lastUpdateTimeInMillis\": \"\"\n },\n \"accountPricingSettings\": {\n \"planDefaultStartUnit\": \"\"\n },\n \"accountDetails\": {\n \"baseCurrency\": \"USD\"\n },\n \"productInvoiceFeesMap\": \"\",\n \"lastUpdateTimeInMillis\": \"\",\n \"lockingStatus\": \"\",\n \"accountId\": \"\",\n \"approvalRuleMap\": \"\",\n \"prepaidPromotions\": \"\",\n \"planCatalogs\": \"\",\n \"usageTransformersMap\": \"\"\n}" }, { "id": "9ENMEm2P3NaWh-4apHW1M", "language": "400", "code": "// Invalid request parameters or malformed query\n" }, { "id": "iL-b2LjeiJ41Do3Ld99sB", "language": "401", "code": "// Authentication required or invalid API key provided\n" }, { "id": "MngOBQ-a1sSP4Ma2AQsCc", "language": "403", "code": "// Insufficient permissions to access account pricing configuration\n" }, { "id": "l4HN2dHxOIqbBqlw4yEI7", "language": "404", "code": "// Account pricing configuration not found or not properly set up\n" }, { "id": "jtielRzfqHxm-Z0H8yAE9", "language": "500", "code": "// Internal server error occurred while retrieving pricing data\n" } ], "selectedLanguageId": "6htDtDhf5lKlPYuxzsT9t" } }, "children": [ { "text": "" } ] }