Create or update a usage transformer

1 min

POST

https://app.amberflo.io/payments/pricing/amberflo/account-pricing/usage-transformer

Body Parameters

bodypayment.pricing.UsageTransformer.in
- idstring
  Description
  Unique identifier for a particular usage transformer.
- namestring
  Description
  Name given to the usage transformer.
- transformUsageDimensionNamestring
  Description
  Name of the dimension used to transform / scale usage.
- productItemIdstring
  Description
  Product item id associated with the usage transformer.
- dimensionsInterpolationscom.amberflo.service.common.dimensions_interpolation.DimensionsInterpolation.in[]
  Description
  List of dimension interpolations, used to derive new dimensions and their values.
  - com.amberflo.service.common.dimensions_interpolation.ListNumericInterpolation.in
    - typestring
      Default
      list_numeric_interpolation
    - dimensionsstring[]
    - newDimensionNamestring
    - operationstring
  - com.amberflo.service.common.dimensions_interpolation.TableInterpolation.in
    - typestring
      Default
      table_interpolation
    - newDimensionNamestring
    - dimensionKeysstring[]
    - dimensionTableRowscom.amberflo.service.common.dimensions_interpolation.TableInterpolationRow.in[]
      - dimensionValuesstring[]
      - newValuenumber
  - com.amberflo.service.common.dimensions_interpolation.TiersInterpolation.in
    - typestring
      Default
      tiers_interpolation
    - newDimensionNamestring
    - dimensionNamestring
    - newDimensionTierMapmap<string, number>
- requiredDimensionsstring[]
- lockingStatuscom.amberflo.service.common.LockingStatus.in
- lastUpdateTimeInMillisinteger<int64>

Responses

200Successful request

payment.pricing.UsageTransformer.out
- idstring
  Description
  Unique identifier for a particular usage transformer.
- namestring
  Description
  Name given to the usage transformer.
- transformUsageDimensionNamestring
  Description
  Name of the dimension used to transform / scale usage.
- productItemIdstring
  Description
  Product item id associated with the usage transformer.
- dimensionsInterpolationscom.amberflo.service.common.dimensions_interpolation.DimensionsInterpolation.out[]
  Description
  List of dimension interpolations, used to derive new dimensions and their values.
  - com.amberflo.service.common.dimensions_interpolation.ListNumericInterpolation.out
    - typestring
      Default
      list_numeric_interpolation
    - dimensionsstring[]
    - newDimensionNamestring
    - operationstring
  - com.amberflo.service.common.dimensions_interpolation.TableInterpolation.out
    - typestring
      Default
      table_interpolation
    - newDimensionNamestring
    - dimensionKeysstring[]
    - dimensionTableRowscom.amberflo.service.common.dimensions_interpolation.TableInterpolationRow.out[]
      - dimensionValuesstring[]
      - newValuenumber
  - com.amberflo.service.common.dimensions_interpolation.TiersInterpolation.out
    - typestring
      Default
      tiers_interpolation
    - newDimensionNamestring
    - dimensionNamestring
    - newDimensionTierMapmap<string, number>
- requiredDimensionsstring[]
- lockingStatuscom.amberflo.service.common.LockingStatus.out
- lastUpdateTimeInMillisinteger<int64>

curl

curl --request POST \
     --url https://app.amberflo.io/payments/pricing/amberflo/account-pricing/usage-transformer \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "dimensionsInterpolations": {
     "type": "list_numeric_interpolation"
     }
     }'

javascript

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

var raw = JSON.stringify({
   "dimensionsInterpolations": {
      "type": "list_numeric_interpolation"
   }
});

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

fetch("https://app.amberflo.io/payments/pricing/amberflo/account-pricing/usage-transformer", 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/usage-transformer")

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({
   "dimensionsInterpolations": {
      "type": "list_numeric_interpolation"
   }
})

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

python

import requests
import json

url = "https://app.amberflo.io/payments/pricing/amberflo/account-pricing/usage-transformer"

payload = json.dumps({
   "dimensionsInterpolations": {
      "type": "list_numeric_interpolation"
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Successful request
{
  "id": "",
  "name": "",
  "transformUsageDimensionName": "",
  "productItemId": "",
  "dimensionsInterpolations": {},
  "requiredDimensions": [
    ""
  ],
  "lockingStatus": "",
  "lastUpdateTimeInMillis": ""
}