Create a custom promotion

1 min

POST

https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion

Body Parameters

bodypayment.pricing.promotions.CustomerCustomPromotion.in
- promotionpayment.pricing.promotions.Promotion.in
  - payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.in
    - idstringrequired
      Description
      Unique id for the promotion.
    - typestring
      Description
      Promotion type.
      Default
      absolute_product_automatic_promotion
    - promotionNamestringrequired
      Description
      Display name for the promotion.
    - descriptionstring
    - lockingStatuscom.amberflo.service.common.LockingStatus.in
    - dimensionConstraintMapmap<string, string>
    - customerTagsmap<string, string>
    - isHiddenboolean
    - discountnumber
    - totalMaxDiscountnumber
    - targetProductIdstring
  - payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.in
    - idstringrequired
      Description
      Unique id for the promotion.
    - typestring
      Description
      Promotion type.
      Default
      absolute_product_item_automatic_promotion
    - promotionNamestringrequired
      Description
      Display name for the promotion.
    - descriptionstring
    - lockingStatuscom.amberflo.service.common.LockingStatus.in
    - dimensionConstraintMapmap<string, string>
    - customerTagsmap<string, string>
    - isHiddenboolean
    - discountnumber
    - totalMaxDiscountnumber
    - targetProductItemIdstring
    - isRegExboolean
      Description
      Determines whether to use regular expression matching for dimension values.
  - payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.in
    - idstringrequired
      Description
      Unique id for the promotion.
    - typestring
      Description
      Promotion type.
      Default
      absolute_product_item_sales_event_promotion
    - promotionNamestringrequired
      Description
      Display name for the promotion.
    - descriptionstring
    - lockingStatuscom.amberflo.service.common.LockingStatus.in
    - dimensionConstraintMapmap<string, string>
      Description
      If not null, apply promotion to dimensions in map
    - customerTagsmap<string, string>
      Description
      If not null, apply promotion to customers that match tags
    - acceptablePromotionTimeRangepayment.common.TimeRange.in
      Description
      The time range over which to apply the promotion
      - startTimeInSecondsinteger<int64>
      - endTimeInSecondsinteger<int64>
    - recurrenceIntervalpayment.pricing.promotions.PromotionRecurrenceInterval.in
      Description
      The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur
      - intervalLengthpayment.pricing.promotions.PromotionRecurringIntervalLength.in
        Description
        The length of the interval
        Max depth limit reached
      - intervalLengthCountinteger<int32>
        Description
        The number of interval lengths in the interval
      - maxRecurrenceinteger<int32>
        Description
        The max number of intervals that the promotion will occur over
    - discountnumber
      Description
      The amount of discount for the promotion
    - targetProductItemIdstring
      Description
      The product item that we want to apply the promotion on
    - isRegExboolean
      Description
      Determines whether to use regular expression matching for dimension values.
  - payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.in
    - idstringrequired
      Description
      Unique id for the promotion.
    - typestring
      Description
      Promotion type.
      Default
      absolute_product_sales_event_promotion
    - promotionNamestringrequired
      Description
      Display name for the promotion.
    - descriptionstring
    - lockingStatuscom.amberflo.service.common.LockingStatus.in
      - Max depth limit reached
    - dimensionConstraintMapmap<string, string>
      Description
      If not null, apply promotion to dimensions in map
    - customerTagsmap<string, string>
      Description
      If not null, apply promotion to customers that match tags
    - acceptablePromotionTimeRangepayment.common.TimeRange.in
      Description
      The time range over which to apply the promotion
      - Max depth limit reached
    - recurrenceIntervalpayment.pricing.promotions.PromotionRecurrenceInterval.in
      Description
      The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur
      - Max depth limit reached
    - discountnumber
      Description
      The amount of discount for the promotion
    - targetProductIdstring
      Description
      The product that we want to apply the promotion on
  - payment.pricing.promotions.pre_created.FreeTrialPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.GenericItemPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.GenericProductPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductFullDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.in
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.AbsolutePlanPromotion.in
    - Max depth limit reached
- customerAppliedPromotionpayment.pricing.customer.CustomerAppliedPromotion.in
  - idstring
    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).
  - productIdstring
    Description
    Unique product id.
  - customerIdstring
    Description
    Unique customer id.
  - promotionIdstring
    Description
    Unique promotion id to define an applied promotion.
  - appliedTimeInSecondsinteger<int64>
    Description
    Deprecated. When a promotion is in use in a customer pricing plan.
  - addedTimeInSecondsinteger<int64>
    Description
    When a promotion has been added to a pricing plan.
  - removedTimeInSecondsinteger<int64>
    Description
    When a promotion has been removed from a customer pricing plan.
  - relationIdstring
    Description
    The unique ID of the relationship between the customer and promotion.
  - appliedTimeRangepayment.common.TimeRange.in
    Description
    When something is applied and removed with hourly granularity.
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
  - prioritynumber
    Description
    How we rank promotions of the same type against each other.
  - removalContextmap<string, string>
    Description
    Identifying metadata around who and why a promotion was removed.
  - commitmentIdstring
    Description
    Optional field, populated by internal processes.
  - entityProductInvoicespayment.billing.detailed.EntityProductInvoice.in[]
    Description
    List of invoices that this customer applied promotion was used on.
    - invoiceUristring
    - createdTimeInSecondsinteger<int64>
    - amountnumber
    - invoiceAmountnumber
  - amountLeftInCyclenumber
    Description
    Amount of promotion left in cycle.
  - totalAmountLeftnumber
    Description
    Amount of promotion left in total.

Responses

200Successful request

payment.pricing.promotions.CustomerCustomPromotion.out
- promotionpayment.pricing.promotions.Promotion.out
  - payment.pricing.promotions.pre_created.AbsoluteProductAutomaticPromotion.out
    - idstringrequired
      Description
      Unique id for the promotion.
    - typestring
      Description
      Promotion type.
      Default
      absolute_product_automatic_promotion
    - promotionNamestringrequired
      Description
      Display name for the promotion.
    - descriptionstring
    - lockingStatuscom.amberflo.service.common.LockingStatus.out
    - lastUpdateTimeInMillisinteger<int64>
      Description
      Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - dimensionConstraintMapmap<string, string>
    - customerTagsmap<string, string>
    - isHiddenboolean
    - discountnumber
    - totalMaxDiscountnumber
    - targetProductIdstring
  - payment.pricing.promotions.pre_created.AbsoluteProductItemAutomaticPromotion.out
    - idstringrequired
      Description
      Unique id for the promotion.
    - typestring
      Description
      Promotion type.
      Default
      absolute_product_item_automatic_promotion
    - promotionNamestringrequired
      Description
      Display name for the promotion.
    - descriptionstring
    - lockingStatuscom.amberflo.service.common.LockingStatus.out
    - lastUpdateTimeInMillisinteger<int64>
      Description
      Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - dimensionConstraintMapmap<string, string>
    - customerTagsmap<string, string>
    - isHiddenboolean
    - discountnumber
    - totalMaxDiscountnumber
    - targetProductItemIdstring
    - isRegExboolean
      Description
      Determines whether to use regular expression matching for dimension values.
  - payment.pricing.promotions.pre_created.AbsoluteProductItemSalesEventPromotion.out
    - idstringrequired
      Description
      Unique id for the promotion.
    - typestring
      Description
      Promotion type.
      Default
      absolute_product_item_sales_event_promotion
    - promotionNamestringrequired
      Description
      Display name for the promotion.
    - descriptionstring
    - lockingStatuscom.amberflo.service.common.LockingStatus.out
    - lastUpdateTimeInMillisinteger<int64>
      Description
      Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - dimensionConstraintMapmap<string, string>
      Description
      If not null, apply promotion to dimensions in map
    - customerTagsmap<string, string>
      Description
      If not null, apply promotion to customers that match tags
    - acceptablePromotionTimeRangepayment.common.TimeRange.out
      Description
      The time range over which to apply the promotion
      - startTimeInSecondsinteger<int64>
      - endTimeInSecondsinteger<int64>
    - recurrenceIntervalpayment.pricing.promotions.PromotionRecurrenceInterval.out
      Description
      The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur
      - intervalLengthpayment.pricing.promotions.PromotionRecurringIntervalLength.out
        Description
        The length of the interval
        Max depth limit reached
      - intervalLengthCountinteger<int32>
        Description
        The number of interval lengths in the interval
      - maxRecurrenceinteger<int32>
        Description
        The max number of intervals that the promotion will occur over
    - discountnumber
      Description
      The amount of discount for the promotion
    - targetProductItemIdstring
      Description
      The product item that we want to apply the promotion on
    - isRegExboolean
      Description
      Determines whether to use regular expression matching for dimension values.
  - payment.pricing.promotions.pre_created.AbsoluteProductSalesEventPromotion.out
    - idstringrequired
      Description
      Unique id for the promotion.
    - typestring
      Description
      Promotion type.
      Default
      absolute_product_sales_event_promotion
    - promotionNamestringrequired
      Description
      Display name for the promotion.
    - descriptionstring
    - lockingStatuscom.amberflo.service.common.LockingStatus.out
      - Max depth limit reached
    - lastUpdateTimeInMillisinteger<int64>
      Description
      Last update time, in [Unix time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds).
    - dimensionConstraintMapmap<string, string>
      Description
      If not null, apply promotion to dimensions in map
    - customerTagsmap<string, string>
      Description
      If not null, apply promotion to customers that match tags
    - acceptablePromotionTimeRangepayment.common.TimeRange.out
      Description
      The time range over which to apply the promotion
      - Max depth limit reached
    - recurrenceIntervalpayment.pricing.promotions.PromotionRecurrenceInterval.out
      Description
      The interval that the promotion recurs over. Defines how often the promotion occurs and the maximum number of times it will occur
      - Max depth limit reached
    - discountnumber
      Description
      The amount of discount for the promotion
    - targetProductIdstring
      Description
      The product that we want to apply the promotion on
  - payment.pricing.promotions.pre_created.FreeTrialPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.GenericItemPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.GenericProductPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.ProductAbsolutePartnerDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.ProductItemAbsolutePartnerDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductItemPartnerDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductAutomaticPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductItemAutomaticPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductItemSalesEventPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.ProductRelativePartnerDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductSalesEventPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TieredAbsoluteProductAutomaticPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TieredAbsoluteProductItemAutomaticPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TieredRelativeProductAutomaticPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TieredRelativeProductItemAutomaticPromotion.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductItemDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedAbsoluteProductDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedRelativeProductItemDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedRelativeProductDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.RelativeProductFullDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductItemDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedTieredAbsoluteProductDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductItemDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.TimeLimitedTieredRelativeProductDiscount.out
    - Max depth limit reached
  - payment.pricing.promotions.pre_created.AbsolutePlanPromotion.out
    - Max depth limit reached
- customerAppliedPromotionpayment.pricing.customer.CustomerAppliedPromotion.out
  - idstring
    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).
  - productIdstring
    Description
    Unique product id.
  - customerIdstring
    Description
    Unique customer id.
  - promotionIdstring
    Description
    Unique promotion id to define an applied promotion.
  - appliedTimeInSecondsinteger<int64>
    Description
    Deprecated. When a promotion is in use in a customer pricing plan.
  - addedTimeInSecondsinteger<int64>
    Description
    When a promotion has been added to a pricing plan.
  - removedTimeInSecondsinteger<int64>
    Description
    When a promotion has been removed from a customer pricing plan.
  - relationIdstring
    Description
    The unique ID of the relationship between the customer and promotion.
  - appliedTimeRangepayment.common.TimeRange.out
    Description
    When something is applied and removed with hourly granularity.
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
  - prioritynumber
    Description
    How we rank promotions of the same type against each other.
  - removalContextmap<string, string>
    Description
    Identifying metadata around who and why a promotion was removed.
  - commitmentIdstring
    Description
    Optional field, populated by internal processes.
  - entityProductInvoicespayment.billing.detailed.EntityProductInvoice.out[]
    Description
    List of invoices that this customer applied promotion was used on.
    - invoiceUristring
    - createdTimeInSecondsinteger<int64>
    - amountnumber
    - invoiceAmountnumber
  - amountLeftInCyclenumber
    Description
    Amount of promotion left in cycle.
  - totalAmountLeftnumber
    Description
    Amount of promotion left in total.

curl

curl --request POST \
     --url https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "promotion": {
     "id": "",
     "type": "absolute_product_automatic_promotion",
     "promotionName": ""
     }
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var raw = JSON.stringify({
   "promotion": {
      "id": "",
      "type": "absolute_product_automatic_promotion",
      "promotionName": ""
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "promotion": {
      "id": "",
      "type": "absolute_product_automatic_promotion",
      "promotionName": ""
   }
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://app.amberflo.io/payments/pricing/amberflo/customer-pricing/custom-promotion"

payload = json.dumps({
   "promotion": {
      "id": "",
      "type": "absolute_product_automatic_promotion",
      "promotionName": ""
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Successful request
{
  "promotion": {},
  "customerAppliedPromotion": {
    "id": "",
    "productId": "",
    "customerId": "",
    "promotionId": "",
    "appliedTimeInSeconds": "",
    "addedTimeInSeconds": "",
    "removedTimeInSeconds": "",
    "relationId": "",
    "appliedTimeRange": {
      "startTimeInSeconds": "",
      "endTimeInSeconds": ""
    },
    "priority": 0,
    "removalContext": "",
    "commitmentId": "",
    "entityProductInvoices": [
      {
        "invoiceUri": "",
        "createdTimeInSeconds": "",
        "amount": 0,
        "invoiceAmount": 0
      }
    ],
    "amountLeftInCycle": 0,
    "totalAmountLeft": 0
  }
}