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

Retrieves all account-level promotions including active, scheduled, and expired promotional campaigns.\nUse this endpoint to review all promotional configurations and manage promotional strategies.

\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 account promotions with discount rules, conditions, and status information", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "Comprehensive promotion definition supporting all promotion types including automatic, partner, sales event, time-limited, and tiered discount structures.", "customType": "payment.pricing.promotions.Promotion.out[]", "schema": [], "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.out", "complexItems": [ { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the promotion within the account scope.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for automatic product-level absolute discounts.", "example": "", "default": "absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for promotion display and management within admin interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining promotion purpose, terms, and usage guidelines.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the promotion.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when promotion was last modified or activated.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Key-value pairs defining usage dimension filters for promotion applicability conditions.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Required customer tag criteria for automatic promotion activation and targeting.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Controls promotion visibility in customer interfaces and billing communications.", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed monetary amount deducted from product charges in account currency.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Optional lifetime limit on total discount amount available across all periods.", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Identifier of the specific product receiving the automatic discount benefits.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "customType": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the promotion within the account scope.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for automatic product item absolute discounts.", "example": "", "default": "absolute_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for promotion display and management within admin interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining promotion purpose, terms, and usage guidelines.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the promotion.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when promotion was last modified or activated.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Key-value pairs defining usage dimension filters with optional regex pattern support.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Required customer tag criteria for automatic promotion activation and targeting.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Controls promotion visibility in customer interfaces and billing communications.", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed monetary amount deducted from product item charges in account currency.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Optional lifetime limit on total discount amount available across all periods.", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Identifier of the specific product item receiving the automatic discount benefits.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Enables regular expression matching for dimension constraint values and targeting flexibility.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "customType": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the sales event promotion within account scope.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for product item sales event absolute discounts.", "example": "", "default": "absolute_product_item_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for promotion display and campaign management interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining sales event purpose, terms, and campaign objectives.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the sales event promotion.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when sales event promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Key-value pairs defining usage dimension filters with optional regex pattern support.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Optional customer tag criteria for targeted promotion activation during events.", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "Required time boundaries defining when promotion is active during sales events.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the beginning of the time range in seconds", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the end of time range or null for open-ended ranges", "example": 0 } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "Optional recurring pattern configuration for repeated promotional campaigns and events.", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "Time unit specification for the recurring interval duration such as days, weeks, months, or years.", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.in", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.in", "schema": [] }, { "name": "intervalLengthCount", "kind": "optional", "type": "integer", "description": "Multiplier for the interval length to create expressions like every three months or fifteen days.", "example": 0 }, { "name": "maxRecurrence", "kind": "optional", "type": "integer", "description": "Maximum number of recurrence cycles allowed for this promotion before it expires automatically.", "example": 0 } ] }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed monetary amount deducted from product item charges in account currency.", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Required identifier of specific product item receiving sales event discount benefits.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Enables regular expression matching for dimension constraint values and targeting flexibility.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "customType": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the sales event promotion within account scope.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for product-level sales event absolute discounts.", "example": "", "default": "absolute_product_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for promotion display and campaign management interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining sales event purpose, terms, and campaign objectives.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the sales event promotion.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when sales event promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Key-value pairs defining usage dimension filters for promotion applicability conditions.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Optional customer tag criteria for targeted promotion activation during events.", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "Required time boundaries defining when promotion is active during sales events.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the beginning of the time range in seconds", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the end of time range or null for open-ended ranges", "example": 0 } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "Optional recurring pattern configuration for repeated promotional campaigns and events.", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "Time unit specification for the recurring interval duration such as days, weeks, months, or years.", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.in", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.in", "schema": [] }, { "name": "intervalLengthCount", "kind": "optional", "type": "integer", "description": "Multiplier for the interval length to create expressions like every three months or fifteen days.", "example": 0 }, { "name": "maxRecurrence", "kind": "optional", "type": "integer", "description": "Maximum number of recurrence cycles allowed for this promotion before it expires automatically.", "example": 0 } ] }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed monetary amount deducted from entire product charges in account currency.", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Required identifier of the specific product receiving sales event discount benefits.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "customType": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the promotion within the account scope.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for free trial promotions.", "example": "", "default": "free_trial_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for promotion display and management purposes.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining promotion purpose and trial terms.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the promotion.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Optional dimension filters restricting trial to specific usage characteristics with regex support.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Optional customer tag criteria for automatic trial activation and targeting.", "example": "", "customType": "map", "schema": [] }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed monetary discount amount applied during trial period in account currency.", "example": "" }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "Time range defining when customers can activate and use the trial promotion.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the beginning of the time range in seconds", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the end of time range or null for open-ended ranges", "example": 0 } ] }, { "name": "maxPromotionDurationInHours", "kind": "optional", "type": "integer", "description": "Maximum duration in hours that trial benefits remain active after activation.", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Product item identifier limiting trial discount to specific service offering.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Enables regular expression matching for dimension constraint values in trial targeting.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "customType": "payment.pricing.promotions.pre_created.FreeTrialPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the generic promotion within account scope.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for generic product item promotions.", "example": "", "default": "generic_item_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for promotion display and management within admin interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining promotion purpose, terms, and usage guidelines.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the promotion.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when promotion was last modified or configured.", "example": 0 }, { "name": "targetItemId", "kind": "optional", "type": "string", "description": "Required identifier of the specific product item receiving promotion benefits.", "example": "" }, { "name": "promotionType", "kind": "optional", "type": "string", "description": "Classification determining promotion behavior for system processing and reporting.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.PromotionType.in", "customType": "payment.pricing.promotions.attributes.PromotionType.in", "schema": [] }, { "name": "condition", "kind": "optional", "type": "object", "description": "Configurable activation criteria defining when promotion applies to customer usage.", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.PromotionCondition.out", "customType": "payment.pricing.promotions.conditions.PromotionCondition.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.conditions.AfterItemPriceThreshold.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.AfterItemPriceThreshold.out", "schema": [ { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Invoice history requirements needed to evaluate the cumulative price threshold condition accurately.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "minThreshold", "kind": "optional", "type": "number", "description": "Minimum cumulative price threshold that must be exceeded for the promotion condition to activate.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Condition type identifier always set to 'after_item_price_threshold' for item price threshold conditions.", "example": "", "default": "after_item_price_threshold" }, { "name": "itemId", "kind": "optional", "type": "string", "description": "Unique identifier of the product item whose cumulative price is monitored for threshold evaluation.", "example": "" } ] }, { "name": "payment.pricing.promotions.conditions.AfterProductPriceThreshold.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.AfterProductPriceThreshold.out", "schema": [ { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Invoice history requirements needed to evaluate the cumulative product price threshold condition accurately.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "minThreshold", "kind": "optional", "type": "number", "description": "Minimum cumulative price threshold that must be exceeded for the promotion condition to activate.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Condition type identifier always set to 'after_product_price_threshold' for product price threshold conditions.", "example": "", "default": "after_product_price_threshold" } ] }, { "name": "payment.pricing.promotions.conditions.CompositeAndCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.CompositeAndCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Condition type identifier always set to 'and_condition' for composite AND condition evaluation.", "example": "", "default": "and_condition" }, { "name": "conditions", "kind": "optional", "type": "object", "description": "Array of promotion conditions that must all be satisfied for this composite condition to pass.", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.PromotionCondition.out", "customType": "payment.pricing.promotions.conditions.PromotionCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.conditions.AfterItemPriceThreshold.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.AfterItemPriceThreshold.out", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] }, { "name": "payment.pricing.promotions.conditions.AfterProductPriceThreshold.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.AfterProductPriceThreshold.out", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] }, { "name": "payment.pricing.promotions.conditions.CompositeAndCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.CompositeAndCondition.out", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] }, { "name": "payment.pricing.promotions.conditions.CustomerTagsCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.CustomerTagsCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Fixed condition identifier for customer tag matching behavior", "example": "", "default": "customer_tag_condition" }, { "name": "customerTagsToFind", "kind": "optional", "type": "map", "description": "Required customer tag key-value pairs for condition activation with exact matching requirements", "example": "", "customType": "map", "schema": [] }, { "name": "granularity", "kind": "optional", "type": "object", "description": "Promotion targeting scope determining product or item-level application of customer tag conditions", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.Granularity.out", "customType": "payment.pricing.promotions.attributes.granularity.Granularity.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.granularity.ProductGranularity.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ProductGranularity.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.NextBillingCycle.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NextBillingCycle.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.NoCondition.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NoCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.SamePlan.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.SamePlan.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.TimeLimited.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.TimeLimited.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.CustomerTagsCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.CustomerTagsCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Fixed condition identifier for customer tag matching behavior", "example": "", "default": "customer_tag_condition" }, { "name": "customerTagsToFind", "kind": "optional", "type": "map", "description": "Required customer tag key-value pairs for condition activation with exact matching requirements", "example": "", "customType": "map", "schema": [] }, { "name": "granularity", "kind": "optional", "type": "object", "description": "Promotion targeting scope determining product or item-level application of customer tag conditions", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.Granularity.out", "customType": "payment.pricing.promotions.attributes.granularity.Granularity.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.granularity.ProductGranularity.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ProductGranularity.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.NextBillingCycle.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NextBillingCycle.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.NoCondition.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NoCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.SamePlan.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.SamePlan.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.TimeLimited.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.TimeLimited.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "promotionModel", "kind": "optional", "type": "object", "description": "Discount calculation model defining amount type and application rules.", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PromotionModel.out", "customType": "payment.pricing.promotions.promotion_model.PromotionModel.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.promotion_model.Absolute.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.Absolute.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Promotion model type identifier always set to 'absolute' for fixed discount amount calculations.", "example": "", "default": "absolute" }, { "name": "measure", "kind": "optional", "type": "object", "description": "Measurement strategy defining how discount units are calculated from invoice pricing information.", "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": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Invoice history requirements needed for accurate discount calculation and application tracking.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum total discount amount that can be applied across all billing cycles for this promotion.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum discount amount that can be applied in a single billing cycle for this promotion.", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed discount amount applied per discount unit as determined by the measure configuration.", "example": "" } ] }, { "name": "payment.pricing.promotions.promotion_model.PriceTieredRelative.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PriceTieredRelative.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Applied promotion model type identifier confirming price-tiered relative percentage discount calculations.", "example": "", "default": "price_tiered_relative" }, { "name": "measure", "kind": "optional", "type": "object", "description": "Applied measure used for calculating discount thresholds, typically TotalPrice for price-based tier evaluation.", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Applied history requirements defining when the tiered promotion becomes active based on customer usage patterns.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across all billing cycles to prevent excessive promotion costs.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management during promotion periods.", "example": "" }, { "name": "discountRatioMap", "kind": "optional", "type": "map", "description": "Applied price threshold map defining percentage discount ratios for each tier level as decimal values.", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "Applied strategy for calculating tiered discounts, either CHOOSE_SINGLE_TIER or STEP_FUNCTION approach.", "modelRef": "#/components/schemas/payment.pricing.prepaid.OfferCalculationStrategy.out", "customType": "payment.pricing.prepaid.OfferCalculationStrategy.out", "schema": [] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "description": "Current setting controlling whether discount tiers accumulate across billing periods or reset per cycle.", "example": "" } ] }, { "name": "payment.pricing.promotions.promotion_model.Relative.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.Relative.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Applied promotion model type identifier confirming relative percentage-based discount calculations.", "example": "", "default": "relative" }, { "name": "measure", "kind": "optional", "type": "object", "description": "Applied measure used to determine which price portion received the percentage discount application.", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Applied history requirements defining when the relative promotion became active based on customer usage patterns.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across all billing cycles to prevent excessive promotion costs.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management during promotion periods.", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Applied fixed percentage discount ratio used on measured price portions as decimal value between zero and one.", "example": "" } ] } ] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Key-value pairs defining usage dimension filters with optional regex pattern support.", "example": "", "customType": "map", "schema": [] }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Enables regular expression matching for dimension constraint values and targeting flexibility.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.out", "customType": "payment.pricing.promotions.pre_created.GenericItemPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the generic promotion within account scope.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for generic product-level promotions.", "example": "", "default": "generic_product_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for promotion display and management within admin interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining promotion purpose, terms, and usage guidelines.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the promotion.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when promotion was last modified or configured.", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Required identifier of the specific product receiving promotion benefits.", "example": "" }, { "name": "promotionType", "kind": "optional", "type": "string", "description": "Classification determining promotion behavior for system processing and reporting.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.PromotionType.in", "customType": "payment.pricing.promotions.attributes.PromotionType.in", "schema": [] }, { "name": "condition", "kind": "optional", "type": "object", "description": "Configurable activation criteria defining when promotion applies to customer usage.", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.PromotionCondition.out", "customType": "payment.pricing.promotions.conditions.PromotionCondition.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.conditions.AfterItemPriceThreshold.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.AfterItemPriceThreshold.out", "schema": [ { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Invoice history requirements needed to evaluate the cumulative price threshold condition accurately.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "minThreshold", "kind": "optional", "type": "number", "description": "Minimum cumulative price threshold that must be exceeded for the promotion condition to activate.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Condition type identifier always set to 'after_item_price_threshold' for item price threshold conditions.", "example": "", "default": "after_item_price_threshold" }, { "name": "itemId", "kind": "optional", "type": "string", "description": "Unique identifier of the product item whose cumulative price is monitored for threshold evaluation.", "example": "" } ] }, { "name": "payment.pricing.promotions.conditions.AfterProductPriceThreshold.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.AfterProductPriceThreshold.out", "schema": [ { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Invoice history requirements needed to evaluate the cumulative product price threshold condition accurately.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "minThreshold", "kind": "optional", "type": "number", "description": "Minimum cumulative price threshold that must be exceeded for the promotion condition to activate.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Condition type identifier always set to 'after_product_price_threshold' for product price threshold conditions.", "example": "", "default": "after_product_price_threshold" } ] }, { "name": "payment.pricing.promotions.conditions.CompositeAndCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.CompositeAndCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Condition type identifier always set to 'and_condition' for composite AND condition evaluation.", "example": "", "default": "and_condition" }, { "name": "conditions", "kind": "optional", "type": "object", "description": "Array of promotion conditions that must all be satisfied for this composite condition to pass.", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.PromotionCondition.out", "customType": "payment.pricing.promotions.conditions.PromotionCondition.out[]", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.conditions.AfterItemPriceThreshold.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.AfterItemPriceThreshold.out", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] }, { "name": "payment.pricing.promotions.conditions.AfterProductPriceThreshold.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.AfterProductPriceThreshold.out", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] }, { "name": "payment.pricing.promotions.conditions.CompositeAndCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.CompositeAndCondition.out", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] }, { "name": "payment.pricing.promotions.conditions.CustomerTagsCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.CustomerTagsCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Fixed condition identifier for customer tag matching behavior", "example": "", "default": "customer_tag_condition" }, { "name": "customerTagsToFind", "kind": "optional", "type": "map", "description": "Required customer tag key-value pairs for condition activation with exact matching requirements", "example": "", "customType": "map", "schema": [] }, { "name": "granularity", "kind": "optional", "type": "object", "description": "Promotion targeting scope determining product or item-level application of customer tag conditions", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.Granularity.out", "customType": "payment.pricing.promotions.attributes.granularity.Granularity.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.granularity.ProductGranularity.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ProductGranularity.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.NextBillingCycle.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NextBillingCycle.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.NoCondition.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NoCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.SamePlan.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.SamePlan.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.TimeLimited.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.TimeLimited.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.CustomerTagsCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.CustomerTagsCondition.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Fixed condition identifier for customer tag matching behavior", "example": "", "default": "customer_tag_condition" }, { "name": "customerTagsToFind", "kind": "optional", "type": "map", "description": "Required customer tag key-value pairs for condition activation with exact matching requirements", "example": "", "customType": "map", "schema": [] }, { "name": "granularity", "kind": "optional", "type": "object", "description": "Promotion targeting scope determining product or item-level application of customer tag conditions", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.Granularity.out", "customType": "payment.pricing.promotions.attributes.granularity.Granularity.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.granularity.ProductGranularity.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ProductGranularity.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.NextBillingCycle.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NextBillingCycle.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.NoCondition.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NoCondition.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.SamePlan.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.SamePlan.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.TimeLimited.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.TimeLimited.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "promotionModel", "kind": "optional", "type": "object", "description": "Discount calculation model defining amount type and application rules.", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PromotionModel.out", "customType": "payment.pricing.promotions.promotion_model.PromotionModel.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.promotion_model.Absolute.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.Absolute.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Promotion model type identifier always set to 'absolute' for fixed discount amount calculations.", "example": "", "default": "absolute" }, { "name": "measure", "kind": "optional", "type": "object", "description": "Measurement strategy defining how discount units are calculated from invoice pricing information.", "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": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Invoice history requirements needed for accurate discount calculation and application tracking.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum total discount amount that can be applied across all billing cycles for this promotion.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum discount amount that can be applied in a single billing cycle for this promotion.", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed discount amount applied per discount unit as determined by the measure configuration.", "example": "" } ] }, { "name": "payment.pricing.promotions.promotion_model.PriceTieredRelative.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PriceTieredRelative.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Applied promotion model type identifier confirming price-tiered relative percentage discount calculations.", "example": "", "default": "price_tiered_relative" }, { "name": "measure", "kind": "optional", "type": "object", "description": "Applied measure used for calculating discount thresholds, typically TotalPrice for price-based tier evaluation.", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Applied history requirements defining when the tiered promotion becomes active based on customer usage patterns.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across all billing cycles to prevent excessive promotion costs.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management during promotion periods.", "example": "" }, { "name": "discountRatioMap", "kind": "optional", "type": "map", "description": "Applied price threshold map defining percentage discount ratios for each tier level as decimal values.", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "Applied strategy for calculating tiered discounts, either CHOOSE_SINGLE_TIER or STEP_FUNCTION approach.", "modelRef": "#/components/schemas/payment.pricing.prepaid.OfferCalculationStrategy.out", "customType": "payment.pricing.prepaid.OfferCalculationStrategy.out", "schema": [] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "description": "Current setting controlling whether discount tiers accumulate across billing periods or reset per cycle.", "example": "" } ] }, { "name": "payment.pricing.promotions.promotion_model.Relative.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.Relative.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "description": "Applied promotion model type identifier confirming relative percentage-based discount calculations.", "example": "", "default": "relative" }, { "name": "measure", "kind": "optional", "type": "object", "description": "Applied measure used to determine which price portion received the percentage discount application.", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "Applied history requirements defining when the relative promotion became active based on customer usage patterns.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across all billing cycles to prevent excessive promotion costs.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management during promotion periods.", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Applied fixed percentage discount ratio used on measured price portions as decimal value between zero and one.", "example": "" } ] } ] } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.out", "customType": "payment.pricing.promotions.pre_created.GenericProductPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the partner discount within the account scope.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for product-level absolute partner discounts.", "example": "", "default": "product_absolute_partner_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for partner discount display and management purposes.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining partner discount purpose and terms.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the partner discount.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when partner discount was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Optional dimension filters restricting discount to specific usage characteristics.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Required customer tag criteria identifying customers eligible for partner discounts.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Controls partner discount visibility in customer interfaces and billing communications.", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed monetary amount deducted from product charges in account currency.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Optional maximum total discount amount across all billing periods.", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Identifier of the specific product receiving partner discount benefits.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "customType": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the product item partner discount promotion instance within your account pricing configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming this is an item-level absolute partner discount promotion targeting specific billable components.", "example": "", "default": "product_item_absolute_partner_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable display name for the item-level partner discount promotion shown in billing interfaces and reports.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed explanation of the partner discount promotion's purpose and targeted item-level business context for internal reference.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock state indicating whether the item-level partner discount promotion can be modified or deleted.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when the item-level partner discount promotion was last modified or created.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Active dimension filters restricting when the item discount applies based on usage characteristics, geographic regions, or metadata attributes.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Key-value pairs identifying customers eligible for item-level partner discounts based on their channel source or technical certification status.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Visibility setting controlling whether the item-level partner discount promotion appears in customer-facing billing statements and invoice line items.", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed monetary amount that will be deducted from individual product item charges when partner discount targeting conditions are met.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum cumulative discount amount applicable across multiple billing cycles for this specific product item and partner customer relationship.", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this partner discount promotion applies to within your account's billable component structure.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Whether to use regular expression pattern matching for dimension constraint values, enabling flexible filtering rules for item targeting.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "customType": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created relative product item partner discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming item-level percentage-based partner discount promotion.", "example": "", "default": "product_item_relative_partner_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created item-level partner discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional explanation of the percentage partner discount promotion's purpose and business context.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock state controlling whether the partner discount promotion 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 partner discount promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when percentage item discount applies based on usage characteristics.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Configured key-value pairs identifying customers eligible for item-level partner discounts based on channel source.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Current visibility setting controlling whether item partner discount appears in customer billing statements.", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Applied percentage discount ratio for product item charges, expressed as decimal between 0 and 1.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum cumulative discount amount across all billing cycles for this item and partner customer.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for this product item and partner customer.", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this percentage-based partner discount promotion targets for billing.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "customType": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the relative product automatic promotion instance within your account pricing configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming this is an automatic percentage-based product-level promotion triggered by customer tag conditions.", "example": "", "default": "relative_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable display name for the automatic percentage product promotion shown in billing interfaces and reports.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed explanation of the automatic promotion's purpose and customer targeting strategy for internal reference.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock state indicating whether the automatic percentage product promotion can be modified or deleted.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when the automatic percentage product promotion was last modified or created.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Active dimension filters restricting when the automatic promotion applies based on usage characteristics, geographic regions, or metadata attributes.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Key-value pairs that customers must possess for the automatic promotion to activate and apply percentage discounts.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Visibility setting controlling whether the automatic percentage promotion appears in customer-facing billing statements and invoice summaries.", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Percentage discount ratio that will be automatically applied to product billing totals, expressed as decimal value between 0 and 1.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum cumulative discount amount applicable across all billing cycles for this automatic promotion and customer combination.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum discount amount that can be applied within a single billing cycle for this automatic promotion instance.", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this automatic percentage promotion applies to within your account's pricing structure.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "customType": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created relative product item automatic promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for item-level automatic percentage discounts.", "example": "", "default": "relative_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the item-level automatic percentage promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the promotion's purpose and customer targeting criteria.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current configuration lock status controlling whether 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 promotion configuration was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied key-value constraints for targeting specific dimension values with optional regex matching.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Configured customer tag key-value pairs that automatically trigger this percentage discount promotion.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Current visibility setting controlling whether promotion appears in customer billing statements.", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Applied percentage discount as decimal value for qualifying usage charges (0.1 equals 10% discount).", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured absolute limit on total discount amount across all billing cycles for cost control.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured absolute limit on discount amount per individual billing cycle for budget management.", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this percentage discount promotion targets for usage charges.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "customType": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created relative product item sales event promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming item-level time-limited percentage-based sales event promotion.", "example": "", "default": "relative_product_item_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created item sales event promotion in campaign interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional explanation of the sales event promotion's purpose and campaign objectives.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock state controlling whether the sales event promotion 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 sales event promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when item promotion applies during sales events.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Configured customer tag criteria for targeted promotion activation during sales campaigns.", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "Configured time boundaries defining when the sales event promotion is active.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the beginning of the time range in seconds", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the end of time range or null for open-ended ranges", "example": 0 } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "Configured recurring pattern for repeated sales events and promotional campaigns.", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "Time unit specification for the recurring interval duration such as days, weeks, months, or years.", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.in", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.in", "schema": [] }, { "name": "intervalLengthCount", "kind": "optional", "type": "integer", "description": "Multiplier for the interval length to create expressions like every three months or fifteen days.", "example": 0 }, { "name": "maxRecurrence", "kind": "optional", "type": "integer", "description": "Maximum number of recurrence cycles allowed for this promotion before it expires automatically.", "example": 0 } ] }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Applied percentage discount ratio for item charges, expressed as decimal between 0 and 1.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum cumulative discount amount across all billing cycles during sales events.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle during the sales event period.", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier receiving percentage discounts during the sales events.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "customType": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the relative product partner discount promotion instance within your account pricing configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming this is a product-level percentage-based partner discount promotion targeting entire products.", "example": "", "default": "relative_product_partner_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable display name for the percentage-based product partner discount promotion shown in billing interfaces and reports.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed explanation of the percentage partner discount promotion's purpose and product-level business context for internal reference.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock state indicating whether the percentage-based product partner discount promotion can be modified or deleted.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when the percentage-based product partner discount promotion was last modified or created.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Active dimension filters restricting when the percentage product discount applies based on usage characteristics, geographic regions, or metadata attributes.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Key-value pairs identifying customers eligible for percentage-based product partner discounts based on channel source or partner relationship status.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Visibility setting controlling whether the percentage-based product partner discount promotion appears in customer-facing billing statements and invoices.", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Percentage discount ratio that will be applied to product billing totals, expressed as decimal value between 0 and 1.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum cumulative discount amount applicable across all billing cycles for this specific product and partner customer relationship.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Maximum discount amount that can be applied within a single billing cycle for this product and partner customer combination.", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this percentage-based partner discount promotion applies to within your account's pricing structure.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "customType": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created relative product sales event promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming product-level time-limited percentage-based sales event promotion.", "example": "", "default": "relative_product_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created product sales event promotion in campaign interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional explanation of the sales event promotion's purpose and campaign objectives.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock state controlling whether the sales event promotion 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 sales event promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when product promotion applies during sales events.", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "Configured customer tag criteria for targeted promotion activation during sales campaigns.", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "Configured time boundaries defining when the sales event promotion is active.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the beginning of the time range in seconds", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "description": "Unix timestamp marking the end of time range or null for open-ended ranges", "example": 0 } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "Configured recurring pattern for repeated sales events and promotional campaigns.", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "Time unit specification for the recurring interval duration such as days, weeks, months, or years.", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.in", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.in", "schema": [] }, { "name": "intervalLengthCount", "kind": "optional", "type": "integer", "description": "Multiplier for the interval length to create expressions like every three months or fifteen days.", "example": 0 }, { "name": "maxRecurrence", "kind": "optional", "type": "integer", "description": "Maximum number of recurrence cycles allowed for this promotion before it expires automatically.", "example": 0 } ] }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Applied percentage discount ratio for entire product charges, expressed as decimal between 0 and 1.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum cumulative discount amount across all billing cycles during sales events.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle during the sales event period.", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier receiving percentage discounts during the sales events.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "customType": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out" }, { "name": "object", "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", "customType": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created tiered absolute product item automatic promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming item-level tiered absolute automatic promotion.", "example": "", "default": "tiered_absolute_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created tiered absolute product item promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the tiered item promotion's purpose and discount structure.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the tiered item 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 item promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when the tiered item 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 item discount promotion activation.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Current visibility setting controlling whether tiered item promotion appears in customer billing statements.", "example": "" }, { "name": "discountMap", "kind": "optional", "type": "map", "description": "Configured usage threshold map defining fixed discount amounts for each item 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": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this tiered absolute promotion targets for discount application.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "customType": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created tiered relative product automatic promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming product-level tiered relative percentage automatic promotion.", "example": "", "default": "tiered_relative_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created tiered relative product promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the tiered percentage 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 percentage 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": "priceToDiscountMap", "kind": "optional", "type": "map", "description": "Configured price threshold map defining percentage discount ratios for each tier level.", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "Applied calculation strategy for tiered discounts, defaults to CHOOSE_SINGLE_TIER when not specified.", "modelRef": "#/components/schemas/payment.pricing.prepaid.OfferCalculationStrategy.out", "customType": "payment.pricing.prepaid.OfferCalculationStrategy.out", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across all billing cycles for cost control.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management.", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this tiered percentage promotion targets for discount application.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "customType": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created tiered relative product item automatic promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming item-level tiered relative percentage automatic promotion.", "example": "", "default": "tiered_relative_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created tiered relative product item promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the tiered item percentage promotion's purpose and discount structure.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the tiered item 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 item promotion was last modified.", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when the tiered item 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 item percentage discount promotion activation.", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "description": "Current visibility setting controlling whether tiered item promotion appears in customer billing statements.", "example": "" }, { "name": "priceToDiscountMap", "kind": "optional", "type": "map", "description": "Configured price threshold map defining percentage discount ratios for each item tier level.", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "Applied calculation strategy for tiered discounts, defaults to CHOOSE_SINGLE_TIER when not specified.", "modelRef": "#/components/schemas/payment.pricing.prepaid.OfferCalculationStrategy.out", "customType": "payment.pricing.prepaid.OfferCalculationStrategy.out", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across all billing cycles for cost control.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management.", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this tiered percentage promotion targets for discount application.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "customType": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created time-limited absolute product item discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming time-limited absolute product item discount promotion.", "example": "", "default": "time_limited_absolute_item_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created time-limited absolute product item discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the time-limited item discount promotion's purpose and activation schedule.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the time-limited item 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 time-limited item promotion was last modified.", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this time-limited absolute discount promotion targets for discounting.", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "Configured time constraints defining promotion duration and automatic activation schedule based on history requirements.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "discount", "kind": "optional", "type": "number", "description": "Applied fixed monetary amount discounted from product item charges during the active promotion period.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across the entire promotion lifetime for cost control.", "example": "" }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when the promotion applies to specific usage characteristics.", "example": "", "customType": "map", "schema": [] }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "customType": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created time-limited absolute product discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming time-limited absolute product discount promotion.", "example": "", "default": "time_limited_absolute_product_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created time-limited absolute product discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the time-limited discount promotion's purpose and activation schedule.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the time-limited 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 time-limited promotion was last modified.", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this time-limited absolute discount promotion targets for discounting.", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "Configured time constraints defining promotion duration and automatic activation schedule based on history requirements.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "discount", "kind": "optional", "type": "number", "description": "Applied fixed monetary amount discounted from product charges during the active promotion period.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across the entire promotion lifetime for cost control.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "customType": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created time-limited relative product item discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming time-limited relative product item discount promotion.", "example": "", "default": "time_limited_relative_item_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created time-limited relative product item discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the time-limited item percentage discount promotion's purpose and activation schedule.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the time-limited item 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 time-limited item promotion was last modified.", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this time-limited percentage discount promotion targets for discounting.", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "Configured time constraints defining promotion duration and automatic activation schedule based on history requirements.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Applied percentage discount ratio for product item charges, expressed as decimal between 0 and 1.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across the entire promotion lifetime for cost control.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management during promotion period.", "example": "" }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when the promotion applies to specific usage characteristics.", "example": "", "customType": "map", "schema": [] }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "customType": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created time-limited relative product discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming time-limited relative product discount promotion.", "example": "", "default": "time_limited_relative_product_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created time-limited relative product discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the time-limited percentage discount promotion's purpose and activation schedule.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the time-limited 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 time-limited promotion was last modified.", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this time-limited percentage discount promotion targets for discounting.", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "Configured time constraints defining promotion duration and automatic activation schedule based on history requirements.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "Applied percentage discount ratio for product charges, expressed as decimal between 0 and 1.", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across the entire promotion lifetime for cost control.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management during promotion period.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "customType": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the full product discount promotion instance within your account pricing configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming this is an unconditional 100% product discount promotion that eliminates all charges.", "example": "", "default": "time_limited_relative_product_full_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable display name for the full product discount promotion shown in billing interfaces and reports.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed explanation of the full discount promotion's strategic purpose and business context for internal reference.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock state indicating whether the full product discount promotion can be modified or deleted.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when the full product discount promotion was last modified or created.", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that receives the complete 100% discount eliminating all charges within your account pricing structure.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "customType": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created time-limited tiered absolute product item discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming time-limited tiered absolute product item discount promotion.", "example": "", "default": "time_limited_tiered_absolute_item_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created time-limited tiered absolute product item discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the time-limited tiered item discount promotion's purpose and activation schedule.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the time-limited tiered item 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 time-limited tiered item promotion was last modified.", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this time-limited tiered discount promotion targets for discounting.", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "Configured time constraints defining promotion duration and automatic activation schedule based on history requirements.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "discountMap", "kind": "optional", "type": "map", "description": "Configured usage threshold map defining fixed discount amounts for each item tier level.", "example": "", "customType": "map", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across the entire promotion lifetime 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": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when the promotion applies to specific usage characteristics.", "example": "", "customType": "map", "schema": [] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "description": "Current setting controlling whether discount tiers accumulate across billing periods or reset per cycle.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "customType": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created time-limited tiered absolute product discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming time-limited tiered absolute product discount promotion.", "example": "", "default": "time_limited_tiered_absolute_product_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created time-limited tiered absolute product discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the time-limited tiered discount promotion's purpose and activation schedule.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the time-limited 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 time-limited tiered promotion was last modified.", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this time-limited tiered discount promotion targets for discounting.", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "Configured time constraints defining promotion duration and automatic activation schedule based on history requirements.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "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 the entire promotion lifetime 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": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "description": "Current setting controlling whether discount tiers accumulate across billing periods or reset per cycle.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "customType": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created time-limited tiered relative product item discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming time-limited tiered relative product item discount promotion.", "example": "", "default": "time_limited_tiered_relative_item_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created time-limited tiered relative product item discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the time-limited tiered item percentage discount promotion's purpose and activation schedule.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the time-limited tiered item 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 time-limited tiered item promotion was last modified.", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "Specific product item identifier that this time-limited tiered percentage discount promotion targets for discounting.", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "Configured time constraints defining promotion duration and automatic activation schedule based on history requirements.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "priceToDiscountMap", "kind": "optional", "type": "map", "description": "Configured price threshold map defining percentage discount ratios for each item tier level.", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "Applied calculation strategy for tiered discounts, defaults to CHOOSE_SINGLE_TIER when not specified.", "modelRef": "#/components/schemas/payment.pricing.prepaid.OfferCalculationStrategy.out", "customType": "payment.pricing.prepaid.OfferCalculationStrategy.out", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across the entire promotion lifetime for cost control.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management during promotion period.", "example": "" }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "Applied dimension filters restricting when the promotion applies to specific usage characteristics.", "example": "", "customType": "map", "schema": [] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "description": "Current setting controlling whether discount tiers accumulate across billing periods or reset per cycle.", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Current setting enabling regular expression pattern matching for dimension constraint values.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "customType": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the created time-limited tiered relative product discount promotion configuration.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier confirming time-limited tiered relative product discount promotion.", "example": "", "default": "time_limited_tiered_relative_product_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the created time-limited tiered relative product discount promotion in billing interfaces.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining the time-limited tiered percentage discount promotion's purpose and activation schedule.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current administrative lock status controlling whether the time-limited 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 time-limited tiered promotion was last modified.", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "Specific product identifier that this time-limited tiered percentage discount promotion targets for discounting.", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "Configured time constraints defining promotion duration and automatic activation schedule based on history requirements.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.in", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.in", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "description": "Minimum number of billing cycles of customer invoice history required for promotion calculations.", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "description": "Minimum number of months of customer invoice history required for promotion calculations.", "example": 0 } ] }, { "name": "priceToDiscountMap", "kind": "optional", "type": "map", "description": "Configured price threshold map defining percentage discount ratios for each tier level.", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "Applied calculation strategy for tiered discounts, defaults to CHOOSE_SINGLE_TIER when not specified.", "modelRef": "#/components/schemas/payment.pricing.prepaid.OfferCalculationStrategy.out", "customType": "payment.pricing.prepaid.OfferCalculationStrategy.out", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum total discount amount across the entire promotion lifetime for cost control.", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "Configured maximum discount amount per billing cycle for consistent budget management during promotion period.", "example": "" }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "description": "Current setting controlling whether discount tiers accumulate across billing periods or reset per cycle.", "example": "" } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "customType": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out" }, { "name": "object", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "Unique identifier for the promotion within the account.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Fixed promotion type identifier for plan-level absolute discounts.", "example": "", "default": "unconditioned_absolute_plan_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Human-readable name for promotion display and management purposes.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "description": "Optional detailed description explaining promotion purpose and terms.", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "Current modification permissions and lifecycle state of the promotion.", "modelRef": "#/components/schemas/common.LockingStatus.in", "customType": "common.LockingStatus.in", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Unix timestamp in milliseconds when promotion was last modified.", "example": 0 }, { "name": "targetPlanId", "kind": "optional", "type": "string", "description": "Identifier of the specific pricing plan receiving the discount.", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "description": "Fixed monetary amount deducted from plan charges in account currency.", "example": "" }, { "name": "promotionType", "kind": "optional", "type": "string", "description": "Classification of promotion behavior for system processing and reporting.", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.PromotionType.in", "customType": "payment.pricing.promotions.attributes.PromotionType.in", "schema": [] } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "customType": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out" } ], "complexType": "oneOf", "isExpanded": true } ] }, { "statusCode": "400", "description": "Invalid request parameters or malformed query filters", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Authentication required or invalid API key provided", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Insufficient permissions to access promotion listings", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "No promotions found or account not properly configured", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal server error occurred while retrieving promotions list", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "LvyNsr2uyw585K4j9kTsc", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/list \\\n --header 'accept: application/json'" }, { "id": "pj7sLFzLATWaqDw5voqBn", "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/promotions/list\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "xBDUPbohYhBVvKtmVwcy1", "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/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": "fTAWNRdk3CnehEYXsr-yN", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/account-pricing/promotions/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": "LvyNsr2uyw585K4j9kTsc" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Returns array of all account promotions with discount rules, conditions, and status information\n[\n \"\"\n]" }, { "id": "response-1-400", "language": "400", "code": "// Invalid request parameters or malformed query filters\n" }, { "id": "response-2-401", "language": "401", "code": "// Authentication required or invalid API key provided\n" }, { "id": "response-3-403", "language": "403", "code": "// Insufficient permissions to access promotion listings\n" }, { "id": "response-4-404", "language": "404", "code": "// No promotions found or account not properly configured\n" }, { "id": "response-5-500", "language": "500", "code": "// Internal server error occurred while retrieving promotions list\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }