Get pricing plan details
1 min
GET
https://app.amberflo.io/customer-portal/pricing-plan/details
Query Parameters
- productItemIdstringDescription
- latestbooleanDescription
- productIdstringDescriptionDefault1
- sessionTokenstringrequiredDescription
Responses
200
- pricing-plan-details-response
- productPlanobject
- billingPeriodobject
- intervalstringDescription
- intervalsCountinteger
- descriptionstring
- feesobject[]
- costnumber
- descriptionstring
- discountableboolean
- idstring
- isOneTimeFeeboolean
- namestring
- prepayableboolean
- isProratedboolean
- prorateToDayboolean
- idstring
- isDefaultboolean
- lastUpdateTimeInMillisinteger
- lockingStatusstringDescription
- planLevelFreeTierobject
- intValinteger
- scaleinteger
- productIdstring
- productItemsobject[]
- defaultItemPriceIdstring
- lastUpdateTimeInMillisinteger
- lockingStatusstringDescription
- productItemIdstring
- productItemPriceobject
- idstring
- lastUpdateTimeInMillisinteger
- lockingStatusstringDescription
- priceobject
- typestring
- productItemIdstring
- productItemPriceNamestring
- productPlanNamestring
- successorPlanIdstring
- transitionStrategystringDescription
- promotionsobject[]
- appliedTimeInSecondsinteger
- productIdstring
- promotionobject
- targetProductIdstring
- targetProductItemIdstring
- descriptionstring
- idstring
- lastUpdateTimeInMillisinteger
- lockingStatusstringDescription
- promotionNamestring
- typestring
curl
curl --request GET \
--url 'https://app.amberflo.io/customer-portal/pricing-plan/details?productId=1&sessionToken=string' \
--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/customer-portal/pricing-plan/details?productId=1&sessionToken=string", 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/customer-portal/pricing-plan/details?productId=1&sessionToken=string")
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/customer-portal/pricing-plan/details?productId=1&sessionToken=string"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Successful response
{
"productPlan": {
"billingPeriod": {
"interval": "",
"intervalsCount": 0
},
"description": "",
"fees": [
{
"cost": 0,
"description": "",
"discountable": false,
"id": "",
"isOneTimeFee": false,
"name": "",
"prepayable": false,
"isProrated": false,
"prorateToDay": false
}
],
"id": "",
"isDefault": false,
"lastUpdateTimeInMillis": 0,
"lockingStatus": "",
"planLevelFreeTier": {
"intVal": 0,
"scale": 0
},
"productId": "",
"productItems": [
{
"defaultItemPriceId": "",
"lastUpdateTimeInMillis": 0,
"lockingStatus": "",
"productItemId": "",
"productItemPrice": {
"id": "",
"lastUpdateTimeInMillis": 0,
"lockingStatus": "",
"price": {
"type": ""
},
"productItemId": "",
"productItemPriceName": ""
}
}
],
"productPlanName": "",
"successorPlanId": "",
"transitionStrategy": ""
},
"promotions": [
{
"appliedTimeInSeconds": 0,
"productId": "",
"promotion": {
"targetProductId": "",
"targetProductItemId": "",
"description": "",
"id": "",
"lastUpdateTimeInMillis": 0,
"lockingStatus": "",
"promotionName": "",
"type": ""
}
}
]
}This endpoint returns the static pricing plan details and the list of current promotions of the customer.