curl --request POST \
--url https://api.getoneprofile.ai/billing/switch_plan/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"cancel_path": "<string>",
"success_path": "<string>",
"billing_interval": "month",
"credit_tier_key": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/billing/switch_plan/"
payload = {
"cancel_path": "<string>",
"success_path": "<string>",
"billing_interval": "month",
"credit_tier_key": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cancel_path: '<string>',
success_path: '<string>',
billing_interval: 'month',
credit_tier_key: '<string>'
})
};
fetch('https://api.getoneprofile.ai/billing/switch_plan/', 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://api.getoneprofile.ai/billing/switch_plan/",
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([
'cancel_path' => '<string>',
'success_path' => '<string>',
'billing_interval' => 'month',
'credit_tier_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://api.getoneprofile.ai/billing/switch_plan/"
payload := strings.NewReader("{\n \"cancel_path\": \"<string>\",\n \"success_path\": \"<string>\",\n \"billing_interval\": \"month\",\n \"credit_tier_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.getoneprofile.ai/billing/switch_plan/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cancel_path\": \"<string>\",\n \"success_path\": \"<string>\",\n \"billing_interval\": \"month\",\n \"credit_tier_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/billing/switch_plan/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cancel_path\": \"<string>\",\n \"success_path\": \"<string>\",\n \"billing_interval\": \"month\",\n \"credit_tier_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"redirect_url": "<string>",
"type": "checkout"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Switch subscription plan
Switch the organization to a new subscription plan, credit volume, or billing interval. Returns the Stripe URL to send the customer to: hosted Checkout for a first paid subscription, or the billing portal’s confirmation flow for a change to an existing one, where Stripe shows the proration and takes the confirmation.
curl --request POST \
--url https://api.getoneprofile.ai/billing/switch_plan/ \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"cancel_path": "<string>",
"success_path": "<string>",
"billing_interval": "month",
"credit_tier_key": "<string>"
}
'import requests
url = "https://api.getoneprofile.ai/billing/switch_plan/"
payload = {
"cancel_path": "<string>",
"success_path": "<string>",
"billing_interval": "month",
"credit_tier_key": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cancel_path: '<string>',
success_path: '<string>',
billing_interval: 'month',
credit_tier_key: '<string>'
})
};
fetch('https://api.getoneprofile.ai/billing/switch_plan/', 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://api.getoneprofile.ai/billing/switch_plan/",
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([
'cancel_path' => '<string>',
'success_path' => '<string>',
'billing_interval' => 'month',
'credit_tier_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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://api.getoneprofile.ai/billing/switch_plan/"
payload := strings.NewReader("{\n \"cancel_path\": \"<string>\",\n \"success_path\": \"<string>\",\n \"billing_interval\": \"month\",\n \"credit_tier_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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://api.getoneprofile.ai/billing/switch_plan/")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"cancel_path\": \"<string>\",\n \"success_path\": \"<string>\",\n \"billing_interval\": \"month\",\n \"credit_tier_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getoneprofile.ai/billing/switch_plan/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cancel_path\": \"<string>\",\n \"success_path\": \"<string>\",\n \"billing_interval\": \"month\",\n \"credit_tier_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"redirect_url": "<string>",
"type": "checkout"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>",
"issues": [
{
"input": "<string>",
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
Body
Request schema for switching subscription plan.
Partial path (e.g. /billing/plans) of where the stripe Checkout session should redirect the user if payment is cancelled.
1 - 255The new product to switch to.
free_plan, team_plan, pro_plan, enterprise_plan Partial path (e.g. /billing/complete) of where the stripe Checkout session should redirect the user if payment is successful.
1 - 255The billing interval to subscribe with.
month, year The credit tier to subscribe to (e.g. 'tier_20k'). Required for products with selectable credit tiers (the Team plan).
1 - 50Response
Successful Response
Where to send the customer to complete the plan change.
There is no "completed" case: Stripe confirms every plan change, so this always carries a URL to leave for.
Was this page helpful?