Assign a product plan to the customer

1 min

POST

https://app.amberflo.io/customer-portal/pricing-plan

Use this endpoint to allow a customer to assign himself a plan.

The plan assignment can be scheduled to start at some point in the future by specifying a startTimeInSeconds.

If you'd like to cancel a customer's current plan, you should define a "default" plan and then use this API to assign it to the customer.

Query Parameters

sessionTokenstringrequired
Description
A required session token used to authenticate API calls made on behalf of a customer. This token is obtained from the Create a session endpoint and must be included with every request to authorize access.

Body Parameters

bodyamberflo-customer-pricing-request
- endTimeInSecondsinteger
  Description
  UTC time in seconds. At the time specified, the plan will revert back to the account default plan. To specify an end time, the account must have a default plan defined. Setting a new plan will automatically update the last plan's end time to match the new plan's start time.
- productIdstring
  Description
  Product ID as defined in account pricing. Change from default only if you have multiple products.
  Default
  1
- productPlanIdstringrequired
  Description
  productPlanId as defined in account pricing and belongs to the provided productId.
- startTimeInSecondsinteger
  Description
  UTC time in seconds. If null then the service will try to replace the current plan with the new one in the upcoming hour (if no current plan exists it will create a new plan starting from today UTC).

Responses

200Successful response

amberflo-customer-pricing-response
- customerIdstring
- endTimeInSecondsinteger
- productIdstring
- productPlanIdstring
- relationIdstring
  Description
  relationId is the unique ID of the relationship between the customer and the specific instance of the customer product plan.
- createdTimeInSecondsinteger
  Description
  The time in epoch seconds which the plan was assigned to the customer (might be later than the createdTimeInSeconds).
- startTimeInSecondsinteger
  Description
  The start time of the plan in epoch seconds (might be later than the createdTimeInSeconds).

curl

curl --request POST \
     --url 'https://app.amberflo.io/customer-portal/pricing-plan?sessionToken=string' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "productId": "1",
     "productPlanId": ""
     }'

javascript

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

var raw = JSON.stringify({
   "productId": "1",
   "productPlanId": ""
});

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

fetch("https://app.amberflo.io/customer-portal/pricing-plan?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?sessionToken=string")

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({
   "productId": "1",
   "productPlanId": ""
})

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

python

import requests
import json

url = "https://app.amberflo.io/customer-portal/pricing-plan?sessionToken=string"

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

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

print(response.text)

200

// Successful response
{
  "customerId": "",
  "endTimeInSeconds": 0,
  "productId": "",
  "productPlanId": "",
  "relationId": "",
  "createdTimeInSeconds": 0,
  "startTimeInSeconds": 0
}

Use this endpoint to allow a customer to assign himself a plan.

The plan assignment can be scheduled to start at some point in the future by specifying a startTimeInSeconds.

If you'd like to cancel a customer's current plan, you should define a "default" plan and then use this API to assign it to the customer.