--- title: Create a custom promotion slug: amberflo-api/create-a-custom-promotion docTags: createdAt: 2024-11-07T15:10:16.976Z --- { "id": "v45R1H66zeiILUT4QxExy", "type": "api-oas-v2", "data": { "method": "POST", "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": "Create a custom promotion", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [], "queryParameters": [], "bodyDataParameters": [ { "kind": "optional", "name": "body", "type": "object", "description": "", "customType": "payment.pricing.promotions.CustomerCustomPromotion.in", "schema": [ { "name": "promotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.in", "customType": "payment.pricing.promotions.Promotion.in", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.in", "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.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "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": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.in", "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.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "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": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.in", "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.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [] }, { "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.in", "customType": "payment.common.TimeRange.in", "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.in", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.in", "schema": [ { "name": "intervalLength", "kind": "optional", "type": "string", "description": "The length of the interval", "modelRef": "#/components/schemas/payment.pricing.promotions.PromotionRecurringIntervalLength.in", "customType": "payment.pricing.promotions.PromotionRecurringIntervalLength.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.in", "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.in", "customType": "com.amberflo.service.common.LockingStatus.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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.in", "customType": "payment.pricing.promotions.PromotionRecurrenceInterval.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.in", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.in", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "customerAppliedPromotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerAppliedPromotion.in", "customType": "payment.pricing.customer.CustomerAppliedPromotion.in", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "The id of the specific instance in time where a promotion (with promotion Id) was applied to a customer (same promotion might be applied multiple times for the same customer).", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Unique product id.", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "Unique customer id.", "example": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "Unique promotion id to define an applied promotion.", "example": "" }, { "name": "appliedTimeInSeconds", "kind": "optional", "type": "integer", "description": "Deprecated. When a promotion is in use in a customer pricing plan.", "example": 0 }, { "name": "addedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been added to a pricing plan.", "example": 0 }, { "name": "removedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been removed from a customer pricing plan.", "example": 0 }, { "name": "relationId", "kind": "optional", "type": "string", "description": "The unique ID of the relationship between the customer and promotion.", "example": "" }, { "name": "appliedTimeRange", "kind": "optional", "type": "object", "description": "When something is applied and removed with hourly granularity.", "modelRef": "#/components/schemas/payment.common.TimeRange.in", "customType": "payment.common.TimeRange.in", "schema": [ { "name": "startTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "endTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 } ] }, { "name": "priority", "kind": "optional", "type": "number", "description": "How we rank promotions of the same type against each other.", "example": "" }, { "name": "removalContext", "kind": "optional", "type": "map", "description": "Identifying metadata around who and why a promotion was removed.", "example": "", "customType": "map", "schema": [] }, { "name": "commitmentId", "kind": "optional", "type": "string", "description": "Optional field, populated by internal processes.", "example": "" }, { "name": "entityProductInvoices", "kind": "optional", "type": "array", "description": "List of invoices that this customer applied promotion was used on.", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.in", "customType": "payment.billing.detailed.EntityProductInvoice.in[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "amountLeftInCycle", "kind": "optional", "type": "number", "description": "Amount of promotion left in cycle.", "example": "" }, { "name": "totalAmountLeft", "kind": "optional", "type": "number", "description": "Amount of promotion left in total.", "example": "" } ] } ], "modelRef": "#/components/schemas/payment.pricing.promotions.CustomerCustomPromotion.in", "isExpanded": true } ], "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.CustomerCustomPromotion.out", "schema": [ { "name": "promotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.Promotion.out", "customType": "payment.pricing.promotions.Promotion.out", "schema": [], "complexType": "oneOf", "complexItems": [ { "name": "payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out", "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": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out", "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": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out", "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "", "description": "", "customType": "Max depth limit reached" } ] }, { "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": "" } ] }, { "name": "payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.FreeTrialPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericItemPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericItemPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.GenericProductPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.GenericProductPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] }, { "name": "payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "description": "", "modelRef": "#/components/schemas/payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out", "schema": [ { "name": "", "description": "", "customType": "Max depth limit reached" } ] } ] }, { "name": "customerAppliedPromotion", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/payment.pricing.customer.CustomerAppliedPromotion.out", "customType": "payment.pricing.customer.CustomerAppliedPromotion.out", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "The id of the specific instance in time where a promotion (with promotion Id) was applied to a customer (same promotion might be applied multiple times for the same customer).", "example": "" }, { "name": "productId", "kind": "optional", "type": "string", "description": "Unique product id.", "example": "" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "Unique customer id.", "example": "" }, { "name": "promotionId", "kind": "optional", "type": "string", "description": "Unique promotion id to define an applied promotion.", "example": "" }, { "name": "appliedTimeInSeconds", "kind": "optional", "type": "integer", "description": "Deprecated. When a promotion is in use in a customer pricing plan.", "example": 0 }, { "name": "addedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been added to a pricing plan.", "example": 0 }, { "name": "removedTimeInSeconds", "kind": "optional", "type": "integer", "description": "When a promotion has been removed from a customer pricing plan.", "example": 0 }, { "name": "relationId", "kind": "optional", "type": "string", "description": "The unique ID of the relationship between the customer and promotion.", "example": "" }, { "name": "appliedTimeRange", "kind": "optional", "type": "object", "description": "When something is applied and removed with hourly granularity.", "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": "priority", "kind": "optional", "type": "number", "description": "How we rank promotions of the same type against each other.", "example": "" }, { "name": "removalContext", "kind": "optional", "type": "map", "description": "Identifying metadata around who and why a promotion was removed.", "example": "", "customType": "map", "schema": [] }, { "name": "commitmentId", "kind": "optional", "type": "string", "description": "Optional field, populated by internal processes.", "example": "" }, { "name": "entityProductInvoices", "kind": "optional", "type": "array", "description": "List of invoices that this customer applied promotion was used on.", "modelRef": "#/components/schemas/payment.billing.detailed.EntityProductInvoice.out", "customType": "payment.billing.detailed.EntityProductInvoice.out[]", "schema": [ { "name": "invoiceUri", "kind": "optional", "type": "string", "example": "" }, { "name": "createdTimeInSeconds", "kind": "optional", "type": "integer", "example": 0 }, { "name": "amount", "kind": "optional", "type": "number", "example": "" }, { "name": "invoiceAmount", "kind": "optional", "type": "number", "example": "" } ] }, { "name": "amountLeftInCycle", "kind": "optional", "type": "number", "description": "Amount of promotion left in cycle.", "example": "" }, { "name": "totalAmountLeft", "kind": "optional", "type": "number", "description": "Amount of promotion left in total.", "example": "" } ] } ], "modelRef": "#/components/schemas/payment.pricing.promotions.CustomerCustomPromotion.out", "isExpanded": true } ] } ], "examples": { "languages": [ { "id": "mAE2bF0LfFhFqZ__4wgrk", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"promotion\": {\n \"id\": \"\",\n \"type\": \"absolute_product_automatic_promotion\",\n \"promotionName\": \"\"\n }\n }'" }, { "id": "JrzkQdTvlI6TF6l259Umv", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"promotion\": {\n \"id\": \"\",\n \"type\": \"absolute_product_automatic_promotion\",\n \"promotionName\": \"\"\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "KI4-7M416MeD9qcst3dAR", "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::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"promotion\": {\n \"id\": \"\",\n \"type\": \"absolute_product_automatic_promotion\",\n \"promotionName\": \"\"\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "qbveETr6GQkdcqCcZRkgy", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion\"\n\npayload = json.dumps({\n \"promotion\": {\n \"id\": \"\",\n \"type\": \"absolute_product_automatic_promotion\",\n \"promotionName\": \"\"\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "mAE2bF0LfFhFqZ__4wgrk" }, "results": { "languages": [ { "id": "TuGt2PjuY5Ece3CRF01Kg", "language": "200", "code": "// Successful request\n{\n \"promotion\": {},\n \"customerAppliedPromotion\": {\n \"id\": \"\",\n \"productId\": \"\",\n \"customerId\": \"\",\n \"promotionId\": \"\",\n \"appliedTimeInSeconds\": \"\",\n \"addedTimeInSeconds\": \"\",\n \"removedTimeInSeconds\": \"\",\n \"relationId\": \"\",\n \"appliedTimeRange\": {\n \"startTimeInSeconds\": \"\",\n \"endTimeInSeconds\": \"\"\n },\n \"priority\": 0,\n \"removalContext\": \"\",\n \"commitmentId\": \"\",\n \"entityProductInvoices\": [\n {\n \"invoiceUri\": \"\",\n \"createdTimeInSeconds\": \"\",\n \"amount\": 0,\n \"invoiceAmount\": 0\n }\n ],\n \"amountLeftInCycle\": 0,\n \"totalAmountLeft\": 0\n }\n}" } ], "selectedLanguageId": "TuGt2PjuY5Ece3CRF01Kg" } }, "children": [ { "text": "" } ] }