Plans
Get a plan
Returns one plan by its id.
This works for private plans as well, not just the ones on your pricing page.
GET
/
api
/
v1
/
plans
/
{id}
Get a plan
curl --request GET \
--url https://your-domain.example/api/v1/plans/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-domain.example/api/v1/plans/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-domain.example/api/v1/plans/{id}', 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://your-domain.example/api/v1/plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-domain.example/api/v1/plans/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-domain.example/api/v1/plans/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-domain.example/api/v1/plans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": 3,
"name": "Professional",
"slug": "professional",
"description": "For growing teams running automated customer campaigns",
"is_public": true,
"is_free": false,
"trial_days": null,
"price": 899,
"billing_period": "monthly",
"registration_url": "https://acme.example.com/register?plan=3",
"features": [
{
"key": "contacts",
"name": "Contacts",
"type": "limit",
"value": 10000
},
{
"key": "conversations",
"name": "Conversations",
"type": "quota",
"value": 5000
},
{
"key": "ai_chat_assist",
"name": "AI Chat Assistant",
"type": "boolean",
"value": null
}
]
},
"meta": {
"currency": {
"code": "INR",
"name": "Rupees",
"symbol": "₹"
},
"billing_periods": [
{
"value": "monthly",
"label": "Monthly",
"suffix": "month",
"is_recurring": true,
"months": 1,
"plan_count": 1
}
]
}
}{
"status": "error",
"message": "Missing API token.",
"error_code": "unauthenticated"
}{
"status": "error",
"message": "This token is missing the required scope: plans:read.",
"error_code": "insufficient_scope"
}{
"status": "error",
"message": "Plan not found.",
"error_code": "not_found"
}{
"status": "error",
"message": "Too many requests.",
"error_code": "rate_limited"
}Authorizations
Workspace API token. Create one under Settings → Core Platform → API Keys and grant it the plans:read scope.
Path Parameters
The plan's id.
Example:
"3"
⌘I
Get a plan
curl --request GET \
--url https://your-domain.example/api/v1/plans/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://your-domain.example/api/v1/plans/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-domain.example/api/v1/plans/{id}', 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://your-domain.example/api/v1/plans/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-domain.example/api/v1/plans/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://your-domain.example/api/v1/plans/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://your-domain.example/api/v1/plans/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": 3,
"name": "Professional",
"slug": "professional",
"description": "For growing teams running automated customer campaigns",
"is_public": true,
"is_free": false,
"trial_days": null,
"price": 899,
"billing_period": "monthly",
"registration_url": "https://acme.example.com/register?plan=3",
"features": [
{
"key": "contacts",
"name": "Contacts",
"type": "limit",
"value": 10000
},
{
"key": "conversations",
"name": "Conversations",
"type": "quota",
"value": 5000
},
{
"key": "ai_chat_assist",
"name": "AI Chat Assistant",
"type": "boolean",
"value": null
}
]
},
"meta": {
"currency": {
"code": "INR",
"name": "Rupees",
"symbol": "₹"
},
"billing_periods": [
{
"value": "monthly",
"label": "Monthly",
"suffix": "month",
"is_recurring": true,
"months": 1,
"plan_count": 1
}
]
}
}{
"status": "error",
"message": "Missing API token.",
"error_code": "unauthenticated"
}{
"status": "error",
"message": "This token is missing the required scope: plans:read.",
"error_code": "insufficient_scope"
}{
"status": "error",
"message": "Plan not found.",
"error_code": "not_found"
}{
"status": "error",
"message": "Too many requests.",
"error_code": "rate_limited"
}