curl --request POST \
--url https://app.famulor.io/api/v1/billing/subscription-change/review \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"addon_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"addon_quantities": {}
}
'import requests
url = "https://app.famulor.io/api/v1/billing/subscription-change/review"
payload = {
"addon_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"addon_quantities": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
addon_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
addon_quantities: {}
})
};
fetch('https://app.famulor.io/api/v1/billing/subscription-change/review', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.famulor.io/api/v1/billing/subscription-change/review",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'addon_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'addon_quantities' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/billing/subscription-change/review"
payload := strings.NewReader("{\n \"addon_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"addon_quantities\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.famulor.io/api/v1/billing/subscription-change/review")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"addon_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"addon_quantities\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/billing/subscription-change/review")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"addon_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"addon_quantities\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"review_ref": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"amount_due": 123,
"tax_amount": 123,
"currency": "<string>",
"summary": "<string>",
"payment_required": true,
"methods": [
{
"payment_method_ref": "<string>",
"type": "<string>",
"brand": "<string>",
"last4": "<string>",
"exp_month": 123,
"exp_year": 123,
"is_default": true
}
],
"billing_url": "<string>"
}
}Review subscription change
Reviews an existing subscription change without submitting the change or charging a card. Provide the complete desired plan and add-on selection. Returns estimated tax, the amount due, masked eligible methods and short-lived references. This operation does not create new subscriptions or checkouts. Resolve pending invoices in the app before requesting another review. Requires a user-owned credential with billing:write scope and owner, admin or billing access in the active workspace. API Access must be enabled.
curl --request POST \
--url https://app.famulor.io/api/v1/billing/subscription-change/review \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"addon_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"addon_quantities": {}
}
'import requests
url = "https://app.famulor.io/api/v1/billing/subscription-change/review"
payload = {
"addon_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"addon_quantities": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
addon_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
plan_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
addon_quantities: {}
})
};
fetch('https://app.famulor.io/api/v1/billing/subscription-change/review', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.famulor.io/api/v1/billing/subscription-change/review",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'addon_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'plan_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'addon_quantities' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.famulor.io/api/v1/billing/subscription-change/review"
payload := strings.NewReader("{\n \"addon_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"addon_quantities\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.famulor.io/api/v1/billing/subscription-change/review")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"addon_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"addon_quantities\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/billing/subscription-change/review")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"addon_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"plan_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"addon_quantities\": {}\n}"
response = http.request(request)
puts response.read_body{
"data": {
"review_ref": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"amount_due": 123,
"tax_amount": 123,
"currency": "<string>",
"summary": "<string>",
"payment_required": true,
"methods": [
{
"payment_method_ref": "<string>",
"type": "<string>",
"brand": "<string>",
"last4": "<string>",
"exp_month": 123,
"exp_year": 123,
"is_default": true
}
],
"billing_url": "<string>"
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.
Body
Complete desired add-on selection, including every add-on to keep.
100monthly, yearly Target plan. Omit only for an add-on-only subscription.
Show child attributes
Show child attributes
Response
Review subscription change.
Show child attributes
Show child attributes