--- title: Get a custom promotion by id slug: amberflo-api/get-a-custom-promotion-by-id docTags: createdAt: 2024-11-07T15:10:16.976Z --- { "id": "WTuAxDeA6XXAMyLXiBj08", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion", "servers": [ { "url": "https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion" } ], "name": "Get a custom promotion by id", "description": "", "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": "Successful request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_item_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "If not null, apply promotion to dimensions in map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "If not null, apply promotion to customers that match tags", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "The time range over which to apply the promotion", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "The length of the interval", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.out", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.out", "schema": [] }, { "name": "intervalLengthCount", "kind": "optional", "type": "integer", "description": "The number of interval lengths in the interval", "example": 0 }, { "name": "maxRecurrence", "kind": "optional", "type": "integer", "description": "The max number of intervals that the promotion will occur over", "example": 0 } ] }, { "name": "discount", "kind": "optional", "type": "number", "description": "The amount of discount for the promotion", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "The product item that we want to apply the promotion on", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "absolute_product_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "If not null, apply promotion to dimensions in map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "If not null, apply promotion to customers that match tags", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "The time range over which to apply the promotion", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "The length of the interval", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.out", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.out", "schema": [] }, { "name": "intervalLengthCount", "kind": "optional", "type": "integer", "description": "The number of interval lengths in the interval", "example": 0 }, { "name": "maxRecurrence", "kind": "optional", "type": "integer", "description": "The max number of intervals that the promotion will occur over", "example": 0 } ] }, { "name": "discount", "kind": "optional", "type": "number", "description": "The amount of discount for the promotion", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "The product that we want to apply the promotion on", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "free_trial_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "If not null, apply promotion to dimensions in map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "If not null, apply promotion to customers that match tags", "example": "", "customType": "map", "schema": [] }, { "name": "discount", "kind": "optional", "type": "number", "description": "The amount of discount for the promotion", "example": "" }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "The time range over which to apply the promotion", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "maxPromotionDurationInHours", "kind": "optional", "type": "integer", "description": "The maximum duration (in hours) that the promotion can be used on invoice after it is applied", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "The product item that we want to apply the promotion on", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "generic_item_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.PromotionType.out", "customType": "payment.pricing.promotions.attributes.PromotionType.out", "schema": [] }, { "name": "condition", "kind": "optional", "type": "object", "description": "", "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": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "minThreshold", "kind": "optional", "type": "number", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "after_item_price_threshold" }, { "name": "itemId", "kind": "optional", "type": "string", "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": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "minThreshold", "kind": "optional", "type": "number", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "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", "example": "", "default": "and_condition" }, { "name": "conditions", "kind": "optional", "type": "object", "description": "", "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", "example": "", "default": "customer_tag_condition" }, { "name": "customerTagsToFind", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "granularity", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.granularity.ProductGranularity.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ProductGranularity.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.NextBillingCycle.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NextBillingCycle.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.NoCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NoCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.SamePlan.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.SamePlan.out", "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", "example": "", "default": "customer_tag_condition" }, { "name": "customerTagsToFind", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "granularity", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.granularity.ProductGranularity.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ProductGranularity.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.NextBillingCycle.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NextBillingCycle.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.NoCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NoCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.SamePlan.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.SamePlan.out", "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": "", "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", "example": "", "default": "absolute" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_unit" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "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", "example": "", "default": "price_tiered_relative" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "discountRatioMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "customType": "payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "schema": [] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "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", "example": "", "default": "relative" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "example": "" } ] } ] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "generic_product_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.PromotionType.out", "customType": "payment.pricing.promotions.attributes.PromotionType.out", "schema": [] }, { "name": "condition", "kind": "optional", "type": "object", "description": "", "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": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "minThreshold", "kind": "optional", "type": "number", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "after_item_price_threshold" }, { "name": "itemId", "kind": "optional", "type": "string", "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": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "minThreshold", "kind": "optional", "type": "number", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "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", "example": "", "default": "and_condition" }, { "name": "conditions", "kind": "optional", "type": "object", "description": "", "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", "example": "", "default": "customer_tag_condition" }, { "name": "customerTagsToFind", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "granularity", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.granularity.ProductGranularity.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ProductGranularity.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.NextBillingCycle.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NextBillingCycle.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.NoCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NoCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.SamePlan.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.SamePlan.out", "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", "example": "", "default": "customer_tag_condition" }, { "name": "customerTagsToFind", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "granularity", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ItemVariantGranularity.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.granularity.ProductGranularity.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.granularity.ProductGranularity.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] } ] }, { "name": "payment.pricing.promotions.conditions.NextBillingCycle.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NextBillingCycle.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.NoCondition.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.NoCondition.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.conditions.SamePlan.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.conditions.SamePlan.out", "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": "", "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", "example": "", "default": "absolute" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_unit" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "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", "example": "", "default": "price_tiered_relative" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "discountRatioMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "customType": "payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "schema": [] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "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", "example": "", "default": "relative" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "requiredHistory", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "product_absolute_partner_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "product_item_absolute_partner_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension values.", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "product_item_relative_partner_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "relative_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "relative_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "relative_product_item_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "If not null, apply promotion to dimensions in map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "If not null, apply promotion to customers that match tags", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "The time range over which to apply the promotion", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "The length of the interval", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.out", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.out", "schema": [] }, { "name": "intervalLengthCount", "kind": "optional", "type": "integer", "description": "The number of interval lengths in the interval", "example": 0 }, { "name": "maxRecurrence", "kind": "optional", "type": "integer", "description": "The max number of intervals that the promotion will occur over", "example": 0 } ] }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "The percent of discount for the promotion", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "The maximum amount of discount that can be applied", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "The maximum amount of discount that can be applied per billing cycle", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "description": "The product item that we want to apply the promotion on", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "relative_product_partner_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discountRatio", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "relative_product_sales_event_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "description": "If not null, apply promotion to dimensions in map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "description": "If not null, apply promotion to customers that match tags", "example": "", "customType": "map", "schema": [] }, { "name": "acceptablePromotionTimeRange", "kind": "optional", "type": "object", "description": "The time range over which to apply the promotion", "modelRef": "#/components/schemas/payment.common.TimeRange.out", "customType": "payment.common.TimeRange.out", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "recurrenceInterval", "kind": "optional", "type": "object", "description": "The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurrenceInterval.out", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.out", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "The length of the interval", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.out", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.out", "schema": [] }, { "name": "intervalLengthCount", "kind": "optional", "type": "integer", "description": "The number of interval lengths in the interval", "example": 0 }, { "name": "maxRecurrence", "kind": "optional", "type": "integer", "description": "The max number of intervals that the promotion will occur over", "example": 0 } ] }, { "name": "discountRatio", "kind": "optional", "type": "number", "description": "The amount of discount for the promotion", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "description": "The maximum amount of discount that can be applied", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "description": "The maximum amount of discount that can be applied per billing cycle", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "description": "The product that we want to apply the promotion on", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "tiered_absolute_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discountMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_unit" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "total_price" } ] } ] }, { "name": "targetProductId", "kind": "optional", "type": "string", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "tiered_absolute_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "discountMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_unit" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "total_price" } ] } ] }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "tiered_relative_product_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priceToDiscountMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "customType": "payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductId", "kind": "optional", "type": "string", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "tiered_relative_product_item_automatic_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "customerTags", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isHidden", "kind": "optional", "type": "boolean", "example": "" }, { "name": "priceToDiscountMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "customType": "payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_absolute_item_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_absolute_product_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_relative_item_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "discountRatio", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_relative_product_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "discountRatio", "kind": "optional", "type": "number", "example": "" }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_relative_product_full_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_tiered_absolute_item_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "discountMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_unit" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "total_price" } ] } ] }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_tiered_absolute_product_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "discountMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "measure", "kind": "optional", "type": "object", "description": "", "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.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnitBatch.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_batch" }, { "name": "batchSize", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "payment.pricing.promotions.attributes.measure.PerUnit.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.PerUnit.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "per_unit" } ] }, { "name": "payment.pricing.promotions.attributes.measure.TotalPrice.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.measure.TotalPrice.out", "schema": [ { "name": "type", "kind": "optional", "type": "string", "example": "", "default": "total_price" } ] } ] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_tiered_relative_item_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductItemId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "priceToDiscountMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "customType": "payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "dimensionConstraintMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "example": "" }, { "name": "isRegEx", "kind": "optional", "type": "boolean", "description": "Determines whether to use regular expression matching for dimension 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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "time_limited_tiered_relative_product_discount" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetProductId", "kind": "optional", "type": "string", "example": "" }, { "name": "promotionTimeLimit", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.HistoryRequirements.out", "customType": "payment.pricing.promotions.attributes.HistoryRequirements.out", "schema": [ { "name": "cycles", "kind": "optional", "type": "integer", "example": 0 }, { "name": "months", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "priceToDiscountMap", "kind": "optional", "type": "map", "example": "", "customType": "map", "schema": [] }, { "name": "discountCalculationStrategy", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "customType": "payment.pricing.promotions.promotion_model.PriceTieredRelative.DiscountCalculationStrategy.out", "schema": [] }, { "name": "totalMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "cycleMaxDiscount", "kind": "optional", "type": "number", "example": "" }, { "name": "acrossBillingPeriods", "kind": "optional", "type": "boolean", "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 id for the promotion.", "example": "" }, { "name": "type", "kind": "optional", "type": "string", "description": "Promotion type.", "example": "", "default": "unconditioned_absolute_plan_promotion" }, { "name": "promotionName", "kind": "required", "type": "string", "description": "Display name for the promotion.", "example": "" }, { "name": "description", "kind": "optional", "type": "string", "example": "" }, { "name": "lockingStatus", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/com.amberflo.service.common.LockingStatus.out", "customType": "com.amberflo.service.common.LockingStatus.out", "schema": [] }, { "name": "lastUpdateTimeInMillis", "kind": "optional", "type": "integer", "description": "Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).", "example": 0 }, { "name": "targetPlanId", "kind": "optional", "type": "string", "example": "" }, { "name": "discount", "kind": "optional", "type": "number", "example": "" }, { "name": "promotionType", "kind": "optional", "type": "string", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.attributes.PromotionType.out", "customType": "payment.pricing.promotions.attributes.PromotionType.out", "schema": [] } ], "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "customType": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out" } ], "complexType": "oneOf", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "s2mw61maJ6hOR-Gwhy_WG", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion \\\n --header 'accept: application/json'" }, { "id": "tGn1fyjFNPnBUv8gcMqIB", "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/customer-pricing/custom-promotion\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "_eMCSWw7AMwqEKJfQHQNL", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion\")\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": "ZFeQbz1rYGH8b59474dIN", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion\"\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": "s2mw61maJ6hOR-Gwhy_WG" }, "results": { "languages": [ { "id": "bZupNLrNMtsQmR6s1_5oq", "language": "200", "code": "// Successful request\n{}" } ], "selectedLanguageId": "bZupNLrNMtsQmR6s1_5oq" } }, "children": [ { "text": "" } ] }