Query the active cost item price generators

1 min

GET

https://app.amberflo.io/payments/pricing/amberflo/account-pricing/cost-item-price/template/list

Responses

200Successful request

payment.pricing.cost.CostItemPriceGenerator.out[]
- objectpayment.pricing.cost.TieredSeatBasedCostItemPriceGenerator.out
  - distinctDimensionsstring[]required
    Description
    Dimensions to evaluate uniqueness.
  - idstringrequired
    Description
    Id associated with the price.
  - leafNodeTypestringrequired
    Description
    Leaf node the price is using.
  - priceTierspayment.pricing.price.PriceTier.out[]required
    Description
    Price for each tier.
    - startAfterUnitinteger<int64>
    - batchSizeinteger<int64>
    - pricePerBatchnumber
  - meterApiNamestringrequired
    Description
    Meter Api name associated with the price.
  - usageGranularitypayment.pricing.price.UsageGranularity.outrequired
    Description
    Time-span to evaluate.
  - groupDimensionsstring[]
    Description
    Dimensions to group the invoice by.
  - costItemPriceNamestring
    Description
    Name of the price machine. Useful for displaying to users.
  - scalarnumber
    Description
    Optional scalar for scaling usage
  - startDateInSecondsinteger<int64>required
    Description
    The date when the cost item takes effective.
  - expirationDateInSecondsinteger<int64>
    Description
    The date when the cost item expires.
  - typestring
    Description
    Type of template, automatically populated.
    Default
    cost_item_tiered_seat_based
- objectpayment.pricing.cost.TieredSeatBasedDimensionCostItemPriceGenerator.out
  - dimensionKeysstring[]required
    Description
    Keys associated with dimension values.
  - distinctDimensionsstring[]required
    Description
    Dimensions to evaluate uniqueness.
  - idstringrequired
    Description
    Id associated with the price.
  - priceTierspayment.pricing.price.generators.TieredPriceGroupInfo.out[]required
    Description
    Price for each tier.
    - dimensionValuesstring[]
    - priceTierspayment.pricing.price.PriceTier.out[]
      - startAfterUnitinteger<int64>
      - batchSizeinteger<int64>
      - pricePerBatchnumber
    - leafNodeTypestringrequired
  - meterApiNamestringrequired
    Description
    Meter Api name associated with the price.
  - usageGranularitypayment.pricing.price.UsageGranularity.outrequired
    Description
    Time-span to evaluate.
  - groupDimensionsstring[]
    Description
    Dimensions to group the invoice by.
  - costItemPriceNamestring
    Description
    Name of the price machine. Useful for displaying to users.
  - scalarnumber
    Description
    Optional scalar for scaling usage
  - startDateInSecondsinteger<int64>required
    Description
    The date when the cost item takes effective.
  - expirationDateInSecondsinteger<int64>
    Description
    The date when the cost item expires.
  - typestring
    Description
    Type of template, automatically populated.
    Default
    cost_item_tiered_seat_based_dimension
- objectpayment.pricing.cost.UsageBasedDimensionCostItemPriceGenerator.out
  - dimensionKeysstring[]required
    Description
    Keys associated with dimension values.
  - idstringrequired
    Description
    Id associated with the price.
  - priceTierspayment.pricing.price.generators.TieredPriceGroupInfo.out[]required
    Description
    Price for each tier.
    - dimensionValuesstring[]
    - priceTierspayment.pricing.price.PriceTier.out[]
      - startAfterUnitinteger<int64>
      - batchSizeinteger<int64>
      - pricePerBatchnumber
    - leafNodeTypestringrequired
  - meterApiNamestringrequired
    Description
    Meter API name id associated with the price.
  - groupDimensionsstring[]
    Description
    Dimensions to group the invoice by.
  - costItemPriceNamestring
    Description
    Name of the price machine. Useful for displaying to users.
  - scalarnumber
    Description
    Optional scalar for scaling usage
  - startDateInSecondsinteger<int64>required
    Description
    The date when the cost item takes effective.
  - expirationDateInSecondsinteger<int64>
    Description
    The date when the cost item expires.
  - typestring
    Description
    Type of template, automatically populated.
    Default
    cost_item_usage_based_dimension
  - useAverageReducerpayment.pricing.price.UsageGranularity.out
    Description
    Usage granularity if using average.
- objectpayment.pricing.cost.UsageBasedNoDimensionCostItemPriceGenerator.out
  - idstringrequired
    Description
    Id associated with the price.
  - leafNodeTypestringrequired
    Description
    Leaf node the price is using.
  - priceTierspayment.pricing.price.PriceTier.out[]required
    Description
    Price for each tier.
    - startAfterUnitinteger<int64>
    - batchSizeinteger<int64>
    - pricePerBatchnumber
  - meterApiNamestringrequired
    Description
    Meter API name associated with the price.
  - groupDimensionsstring[]
    Description
    Dimensions to group the invoice by.
  - costItemPriceNamestring
    Description
    Name of the price machine. Useful for displaying to users.
  - scalarnumber
    Description
    Optional scalar for scaling usage
  - startDateInSecondsinteger<int64>required
    Description
    The date when the cost item takes effective.
  - expirationDateInSecondsinteger<int64>
    Description
    The date when the cost item expires.
  - typestring
    Description
    Type of template, automatically populated.
    Default
    cost_item_usage_based_no_dimension
  - useAverageReducerpayment.pricing.price.UsageGranularity.out
    Description
    Usage granularity if using average.

curl

curl --request GET \
     --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing/cost-item-price/template/list \
     --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/payments/pricing/amberflo/account-pricing/cost-item-price/template/list", 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/account-pricing/cost-item-price/template/list")

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/payments/pricing/amberflo/account-pricing/cost-item-price/template/list"

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

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

print(response.text)

200

// Successful request
[
  ""
]