Get a price model

1 min

GET

https://app.amberflo.io/pricing/modeling/price-model

Responses

200Successful request

com.amberflo.analysis.modeling.price_model.PriceModel.out
- namestring
  Description
  The name of the price model.
- descriptionstring
  Description
  The description for the price model.
- idstring
  Description
  The unique ID for the price model.
- requestcom.amberflo.analysis.modeling.price_modeling.PricingPlansModelingRequest.out
  Description
  The request which is used to compute this price model.
  - segmentscom.amberflo.analysis.segmentation.AccountUsageClusterSegment.out[]
    Description
    The list of the segments for the customers.
    - meterUsageClusterSegmentscom.amberflo.analysis.segmentation.MeterUsageClusterSegment.out[]
      Description
      A list of usage statics for each meter requested.
      - meterApiNamestring
        Description
        The meter-api-name.
      - groupInfopayment.meters.GroupInfo.out
        Description
        The dimension of the meter Api Name.
        gimap<string, string>
      - usageBucketListcom.amberflo.analysis.segmentation.MeterUsageSegmentBucket.out[]
        Description
        The list of the usage buckets in the customer cluster segment.
        usagenumber
        Description
        The average usage for the customers in the bucket.
        amountOfCustomersnumber
        Description
        The number of customers in the bucket.
        monthlyCustomerTrendnumber
        Description
        How many customers on average to join or leave this bucket every month
      - averageUsagenumber
        Description
        Avg usage over all customers.
    - customersInSegmentinteger<int32>
      Description
      Number of customers in the segment.
  - productItemConstraintsmap<string, com.amberflo.analysis.modeling.price_modeling.constraint.PricingPlansModelingProductItemConstraint.out>
    Description
    The constraints for product item or meter, ordered by meter api name.
  - segmentConstraintscom.amberflo.analysis.modeling.price_modeling.constraint.PricingPlansModelingSegmentConstraint.out[]
    Description
    The list of segment requests for pricing plans. They are in the same order with the segments.
    - flatRatePricecom.amberflo.analysis.modeling.price_modeling.constraint.MinMaxConstraint.out
      Description
      The constraint for the flat rate for the segmentation.
      - minnumber
        Description
        The minimum value for the required value.
      - maxnumber
        Description
        The maximum value for the required value. Zero means not allowed.
    - revenuecom.amberflo.analysis.modeling.price_modeling.constraint.MinMaxConstraint.out
      Description
      The constraint for the revenue from the segmentation.
      - minnumber
        Description
        The minimum value for the required value.
      - maxnumber
        Description
        The maximum value for the required value. Zero means not allowed.
  - constraintcom.amberflo.analysis.modeling.price_modeling.constraint.PricingPlansModelingConstraint.out
    Description
    The overall constraints for the pricing plan.
    - amountOfTierscom.amberflo.analysis.modeling.price_modeling.constraint.MinMaxConstraint.out
      Description
      The constraint on how many tiers for tiered pricing plan. Default from 1 - 3.
      - minnumber
        Description
        The minimum value for the required value.
      - maxnumber
        Description
        The maximum value for the required value. Zero means not allowed.
    - itemUsageRevenueWeightcom.amberflo.analysis.modeling.price_modeling.constraint.MinMaxConstraint.out
      Description
      The weight of usage revenue over total revenue. From 0.0 to 1.0
      - minnumber
        Description
        The minimum value for the required value.
      - maxnumber
        Description
        The maximum value for the required value. Zero means not allowed.
    - itemUsageRevenuecom.amberflo.analysis.modeling.price_modeling.constraint.MinMaxConstraint.out
      Description
      The constraint on usage revenue.
      - minnumber
        Description
        The minimum value for the required value.
      - maxnumber
        Description
        The maximum value for the required value. Zero means not allowed.
    - flatRateRevenueWeightcom.amberflo.analysis.modeling.price_modeling.constraint.MinMaxConstraint.out
      Description
      The weight of fixed rate revenue over total revenue. From 0.0 to 1.0
      - minnumber
        Description
        The minimum value for the required value.
      - maxnumber
        Description
        The maximum value for the required value. Zero means not allowed.
    - flatRateRevenuecom.amberflo.analysis.modeling.price_modeling.constraint.MinMaxConstraint.out
      Description
      The constraint on fixed rate revenue.
      - minnumber
        Description
        The minimum value for the required value.
      - maxnumber
        Description
        The maximum value for the required value. Zero means not allowed.
    - revenuecom.amberflo.analysis.modeling.price_modeling.constraint.MinMaxConstraint.out
      Description
      The constraint on total revenue.
      - minnumber
        Description
        The minimum value for the required value.
      - maxnumber
        Description
        The maximum value for the required value. Zero means not allowed.
  - trendTimeRangepayment.common.TimeRange.out
    Description
    The time range for the trends with the pricing models.
    - startTimeInSecondsinteger<int64>
    - endTimeInSecondsinteger<int64>
- responsecom.amberflo.analysis.modeling.price_modeling.PricingPlansModelingResponse.out
  Description
  The response which the price modeling returns.
  - recommendationscom.amberflo.analysis.modeling.price_modeling.PricingPlansModelingRecommendation.out[]
    Description
    The list of recommendations for the giving segmentations.
    - segmentPricingPlanscom.amberflo.analysis.modeling.price_modeling.PricingPlansModelingSegmentResponse.out[]
      Description
      The list of pricing plan for customers segmentations.
      - segmentcom.amberflo.analysis.segmentation.AccountUsageClusterSegment.out
        Description
        The customer segmentation.
        meterUsageClusterSegmentscom.amberflo.analysis.segmentation.MeterUsageClusterSegment.out[]
        Description
        A list of usage statics for each meter requested.
        meterApiNamestring
        Description
        The meter-api-name.
        groupInfopayment.meters.GroupInfo.out
        Description
        The dimension of the meter Api Name.
        Max depth limit reached
        usageBucketListcom.amberflo.analysis.segmentation.MeterUsageSegmentBucket.out[]
        Description
        The list of the usage buckets in the customer cluster segment.
        Max depth limit reached
        averageUsagenumber
        Description
        Avg usage over all customers.
        customersInSegmentinteger<int32>
        Description
        Number of customers in the segment.
      - flatRatePricenumber
        Description
        The flat rate price for this segmentation.
      - meterTierPricesmap<string, object>
        Description
        The tiered prices for meters without dimensions, ordered by meter api names.
      - meterDimensionTierPricescom.amberflo.analysis.modeling.price_modeling.MeterUsageDimensionTieredPrice.out[]
        Description
        The tiered prices for meters with dimensions.
        meterApiNamestring
        Description
        The meter-api-name.
        groupInfopayment.meters.GroupInfo.out
        Description
        The dimension of the meter Api Name.
        gimap<string, string>
        tierPricesmap<string, number>
        Description
        The list of the usage buckets in the customer cluster segment.
      - revenuenumber
        Description
        The revenue from this segmentation.
      - averageRevenuePerCustomernumber
        Description
        The average charge per customer in the segmentation.
      - flatRateRevenuenumber
        Description
        The revenue from flat rate.
      - flatRateRevenueWeightnumber
        Description
        The weight of the revenue from flat rate.
      - itemUsageRevenuenumber
        Description
        The revenue from item usage.
      - itemUsageRevenueWeightnumber
        Description
        The weight of the revenue from item usage.
      - trendscom.amberflo.analysis.modeling.price_modeling.PricingPlansModelingSegmentTrend.out[]
        Description
        The list of trends for this segmentation.
        startTimeInSecondsinteger<int64>
        Description
        The start time of the invoice.
        segmentcom.amberflo.analysis.segmentation.AccountUsageClusterSegment.out
        Description
        The customer segmentation.
        meterUsageClusterSegmentscom.amberflo.analysis.segmentation.MeterUsageClusterSegment.out[]
        Description
        A list of usage statics for each meter requested.
        Max depth limit reached
        customersInSegmentinteger<int32>
        Description
        Number of customers in the segment.
        revenuenumber
        Description
        The predicated revenue for the invoice.
    - revenuenumber
      Description
      The total revenue.
    - averageRevenuePerCustomernumber
      Description
      The average charge per customer.
    - flatRateRevenuenumber
      Description
      The revenue from flat rate.
    - flatRateRevenueWeightnumber
      Description
      The weight of the revenue from flat rate.
    - itemUsageRevenuenumber
      Description
      The revenue from item usage.
    - itemUsageRevenueWeightnumber
      Description
      The weight of the revenue from item usage.
- createdAtTimeInSecondsinteger<int64>
  Description
  The time when the price model is saved.

curl

curl --request GET \
     --url https://app.amberflo.io/pricing/modeling/price-model \
     --header 'accept: application/json'

javascript

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

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://app.amberflo.io/pricing/modeling/price-model", 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/pricing/modeling/price-model")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://app.amberflo.io/pricing/modeling/price-model"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Successful request
{
  "name": "",
  "description": "",
  "id": "",
  "request": {
    "segments": [
      {
        "meterUsageClusterSegments": [
          {
            "meterApiName": "",
            "groupInfo": {
              "gi": ""
            },
            "usageBucketList": [
              {
                "usage": 0,
                "amountOfCustomers": 0,
                "monthlyCustomerTrend": 0
              }
            ],
            "averageUsage": 0
          }
        ],
        "customersInSegment": ""
      }
    ],
    "productItemConstraints": "",
    "segmentConstraints": [
      {
        "flatRatePrice": {
          "min": 0,
          "max": 0
        },
        "revenue": {
          "min": 0,
          "max": 0
        }
      }
    ],
    "constraint": {
      "amountOfTiers": {
        "min": 0,
        "max": 0
      },
      "itemUsageRevenueWeight": {
        "min": 0,
        "max": 0
      },
      "itemUsageRevenue": {
        "min": 0,
        "max": 0
      },
      "flatRateRevenueWeight": {
        "min": 0,
        "max": 0
      },
      "flatRateRevenue": {
        "min": 0,
        "max": 0
      },
      "revenue": {
        "min": 0,
        "max": 0
      }
    },
    "trendTimeRange": {
      "startTimeInSeconds": "",
      "endTimeInSeconds": ""
    }
  },
  "response": {
    "recommendations": [
      {
        "segmentPricingPlans": [
          {
            "segment": {
              "meterUsageClusterSegments": [
                {
                  "meterApiName": "",
                  "groupInfo": {
                    "": ""
                  },
                  "usageBucketList": [
                    {
                      "": ""
                    }
                  ],
                  "averageUsage": 0
                }
              ],
              "customersInSegment": ""
            },
            "flatRatePrice": 0,
            "meterTierPrices": "",
            "meterDimensionTierPrices": [
              {
                "meterApiName": "",
                "groupInfo": {
                  "gi": ""
                },
                "tierPrices": ""
              }
            ],
            "revenue": 0,
            "averageRevenuePerCustomer": 0,
            "flatRateRevenue": 0,
            "flatRateRevenueWeight": 0,
            "itemUsageRevenue": 0,
            "itemUsageRevenueWeight": 0,
            "trends": [
              {
                "startTimeInSeconds": "",
                "segment": {
                  "meterUsageClusterSegments": [
                    {
                      "": ""
                    }
                  ],
                  "customersInSegment": ""
                },
                "revenue": 0
              }
            ]
          }
        ],
        "revenue": 0,
        "averageRevenuePerCustomer": 0,
        "flatRateRevenue": 0,
        "flatRateRevenueWeight": 0,
        "itemUsageRevenue": 0,
        "itemUsageRevenueWeight": 0
      }
    ]
  },
  "createdAtTimeInSeconds": ""
}