--- title: Create tiered absolute product automatic promotion slug: reference/create-tiered-absolute-product-automatic-promotion docTags: createdAt: 2025-03-18T18:28:02.919Z --- { "id": "gxBgoC_rpDMhRBrEBkvg9", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/tiered_absolute_product_automatic_promotion", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/tiered_absolute_product_automatic_promotion" } ], "name": "Create tiered absolute product automatic promotion", "description": "

Creates a tiered promotion with escalating fixed-amount discounts based on usage or spending thresholds.

\n

Customers automatically qualify for higher discount tiers as their usage increases. Each tier provides\nprogressively higher fixed dollar amount discounts on all product billing within that tier.

\n

Use this for volume-based loyalty programs, enterprise customer retention, or growth acceleration\nprograms where you want fixed-amount discounts that increase with customer engagement levels.

\n\n

Advanced Tier Management:

\n\n

Customer Benefits:

\n", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Tiered absolute product automatic promotion configuration with tier thresholds, discount amounts, and customer tag criteria", "customType": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the tiered absolute product automatic promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for product-level tiered absolute automatic promotions.", "example": "", "default": "tiered_absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the tiered absolute product promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the tiered promotion's purpose and discount structure.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Administrative lock status controlling whether the tiered promotion settings can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Optional dimension filters restricting when the tiered promotion applies to specific usage characteristics.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Required customer tag criteria that automatically trigger tiered discount promotion activation.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Controls whether the tiered promotion appears in customer-facing billing statements and interfaces.", "example": "" }, { "name": "discountMap", "kind": "optional", "type": "map", "description": "Usage threshold map defining fixed discount amounts for each tier level.", "example": "", "customType": "map", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Optional maximum total discount amount across all billing cycles for cost control.", "example": "" }, { "name": "measure", "kind": "optional", "type": "object", "description": "Measure for calculating discount thresholds, defaults to TotalPrice when not specified.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.Measure.in", "customType": "payment.pricing.promotions.attributes.measure.Measure.in", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.attributes.measure.PerUnitBatch.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Measure type identifier always set to 'per_batch' for batch-based discount calculations.", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "description": "Number of usage units grouped together to form a single discountable batch for promotion calculations.", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Measure type identifier always set to 'per_unit' for per-unit discount calculations.", "example": "", "default": "per_unit" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Measure type identifier always set to 'total_price' for total price discount calculations.", "example": "", "default": "total_price" } ] } ] }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this tiered absolute promotion targets for discount application.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "X-API-KEY", "kind": "optional", "type": "apiKey", "in": "header" } ] }, "responses": [ { "statusCode": "200", "description": "Tiered absolute product automatic promotion successfully created", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "Created tiered promotion applying fixed-amount discounts to product charges based on usage thresholds and customer tags.", "customType": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created tiered absolute product automatic promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming product-level tiered absolute automatic promotion.", "example": "", "default": "tiered_absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created tiered absolute product promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the tiered promotion's purpose and discount structure.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the tiered promotion settings can be modified.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when the tiered promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when the tiered promotion applies to specific usage characteristics.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Configured customer tag criteria that automatically trigger tiered discount promotion activation.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Current visibility setting controlling whether tiered promotion appears in customer billing statements.", "example": "" }, { "name": "discountMap", "kind": "optional", "type": "map", "description": "Configured usage threshold map defining fixed discount amounts for each tier level.", "example": "", "customType": "map", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across all billing cycles for cost control.", "example": "" }, { "name": "measure", "kind": "optional", "type": "object", "description": "Applied measure for calculating discount thresholds, defaults to TotalPrice when not specified.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.Measure.out", "customType": "payment.pricing.promotions.attributes.measure.Measure.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.attributes.measure.PerUnitBatch.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Measure type identifier always set to 'per_batch' for batch-based discount calculations.", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "description": "Number of usage units grouped together to form a single discountable batch for promotion calculations.", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Measure type identifier always set to 'per_unit' for per-unit discount calculations.", "example": "", "default": "per_unit" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.in", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Measure type identifier always set to 'total_price' for total price discount calculations.", "example": "", "default": "total_price" } ] } ] }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this tiered absolute promotion targets for discount application.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request - invalid tier configuration or promotion parameters", "jsonExample": "", "isExpanded": true }, { "statusCode": "409", "description": "Conflict - tiered promotion conflicts with existing automatic promotions", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "-Vr9hKNJopBADsiTw_L7S", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/tiered_absolute_product_automatic_promotion \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"id\": \"\",\n \"type\": \"tiered_absolute_product_automatic_promotion\",\n \"promotionName\": \"\",\n \"measure\": {\n \"type\": \"per_batch\"\n }\n }'" }, { "id": "s2-bG8pOMgjXbXYZEwYEs", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"id\": \"\",\n \"type\": \"tiered_absolute_product_automatic_promotion\",\n \"promotionName\": \"\",\n \"measure\": {\n \"type\": \"per_batch\"\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/tiered_absolute_product_automatic_promotion\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "-u_5gq4RjTXbG6CHkSojM", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/tiered_absolute_product_automatic_promotion\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"id\": \"\",\n \"type\": \"tiered_absolute_product_automatic_promotion\",\n \"promotionName\": \"\",\n \"measure\": {\n \"type\": \"per_batch\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "GBszQ_IlNN97EXrux0iZm", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/tiered_absolute_product_automatic_promotion\"\n\npayload = json.dumps({\n \"id\": \"\",\n \"type\": \"tiered_absolute_product_automatic_promotion\",\n \"promotionName\": \"\",\n \"measure\": {\n \"type\": \"per_batch\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "-Vr9hKNJopBADsiTw_L7S" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Tiered absolute product automatic promotion successfully created\n{\n \"id\": \"\",\n \"type\": \"\",\n \"promotionName\": \"\",\n \"description\": \"\",\n \"lockingStatus\": \"\",\n \"lastUpdateTimeInMillis\": \"\",\n \"dimensionConstraintMap\": \"\",\n \"customerTags\": \"\",\n \"isHidden\": false,\n \"discountMap\": \"\",\n \"totalMaxDiscount\": 0,\n \"measure\": {},\n \"targetProductId\": \"\"\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad request - invalid tier configuration or promotion parameters\n" }, { "id": "response-2-409", "language": "409", "code": "// Conflict - tiered promotion conflicts with existing automatic promotions\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }