Create Agency Billing Plan
curl --request POST \
--url 'https://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"bots_count": 123,
"queries_count": 123,
"words_count": 123,
"voice_seconds": 123,
"premium_support": true,
"default_plan": false,
"remove_branding": false,
"advanced_intents": false,
"auto_intents": false,
"billing_plan_group": "<string>",
"credits": {},
"attributes": {},
"agency_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_lookup_key": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key="
payload = {
"name": "<string>",
"description": "<string>",
"bots_count": 123,
"queries_count": 123,
"words_count": 123,
"voice_seconds": 123,
"premium_support": True,
"default_plan": False,
"remove_branding": False,
"advanced_intents": False,
"auto_intents": False,
"billing_plan_group": "<string>",
"credits": {},
"attributes": {},
"agency_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_lookup_key": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
bots_count: 123,
queries_count: 123,
words_count: 123,
voice_seconds: 123,
premium_support: true,
default_plan: false,
remove_branding: false,
advanced_intents: false,
auto_intents: false,
billing_plan_group: '<string>',
credits: {},
attributes: {},
agency_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
plan_lookup_key: '<string>'
})
};
fetch('https://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=', 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.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=",
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([
'name' => '<string>',
'description' => '<string>',
'bots_count' => 123,
'queries_count' => 123,
'words_count' => 123,
'voice_seconds' => 123,
'premium_support' => true,
'default_plan' => false,
'remove_branding' => false,
'advanced_intents' => false,
'auto_intents' => false,
'billing_plan_group' => '<string>',
'credits' => [
],
'attributes' => [
],
'agency_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'plan_lookup_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key="
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"bots_count\": 123,\n \"queries_count\": 123,\n \"words_count\": 123,\n \"voice_seconds\": 123,\n \"premium_support\": true,\n \"default_plan\": false,\n \"remove_branding\": false,\n \"advanced_intents\": false,\n \"auto_intents\": false,\n \"billing_plan_group\": \"<string>\",\n \"credits\": {},\n \"attributes\": {},\n \"agency_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plan_lookup_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"bots_count\": 123,\n \"queries_count\": 123,\n \"words_count\": 123,\n \"voice_seconds\": 123,\n \"premium_support\": true,\n \"default_plan\": false,\n \"remove_branding\": false,\n \"advanced_intents\": false,\n \"auto_intents\": false,\n \"billing_plan_group\": \"<string>\",\n \"credits\": {},\n \"attributes\": {},\n \"agency_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plan_lookup_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"bots_count\": 123,\n \"queries_count\": 123,\n \"words_count\": 123,\n \"voice_seconds\": 123,\n \"premium_support\": true,\n \"default_plan\": false,\n \"remove_branding\": false,\n \"advanced_intents\": false,\n \"auto_intents\": false,\n \"billing_plan_group\": \"<string>\",\n \"credits\": {},\n \"attributes\": {},\n \"agency_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plan_lookup_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Data created successfully",
"meta": {},
"data": {
"name": "<string>",
"description": "<string>",
"bots_count": 123,
"queries_count": 123,
"words_count": 123,
"voice_seconds": 123,
"premium_support": true,
"default_plan": false,
"remove_branding": false,
"advanced_intents": false,
"auto_intents": false,
"billing_plan_group": "<string>",
"credits": {},
"attributes": {},
"agency_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_lookup_key": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Agency Billing
Create Agency Billing Plan
Create a new billing plan for the agency
POST
/
api
/
v1
/
agency
/
billing
/
{agency_id}
/
billing_plan
Create Agency Billing Plan
curl --request POST \
--url 'https://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"bots_count": 123,
"queries_count": 123,
"words_count": 123,
"voice_seconds": 123,
"premium_support": true,
"default_plan": false,
"remove_branding": false,
"advanced_intents": false,
"auto_intents": false,
"billing_plan_group": "<string>",
"credits": {},
"attributes": {},
"agency_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_lookup_key": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key="
payload = {
"name": "<string>",
"description": "<string>",
"bots_count": 123,
"queries_count": 123,
"words_count": 123,
"voice_seconds": 123,
"premium_support": True,
"default_plan": False,
"remove_branding": False,
"advanced_intents": False,
"auto_intents": False,
"billing_plan_group": "<string>",
"credits": {},
"attributes": {},
"agency_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_lookup_key": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
bots_count: 123,
queries_count: 123,
words_count: 123,
voice_seconds: 123,
premium_support: true,
default_plan: false,
remove_branding: false,
advanced_intents: false,
auto_intents: false,
billing_plan_group: '<string>',
credits: {},
attributes: {},
agency_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
plan_lookup_key: '<string>'
})
};
fetch('https://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=', 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.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=",
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([
'name' => '<string>',
'description' => '<string>',
'bots_count' => 123,
'queries_count' => 123,
'words_count' => 123,
'voice_seconds' => 123,
'premium_support' => true,
'default_plan' => false,
'remove_branding' => false,
'advanced_intents' => false,
'auto_intents' => false,
'billing_plan_group' => '<string>',
'credits' => [
],
'attributes' => [
],
'agency_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'plan_lookup_key' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key="
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"bots_count\": 123,\n \"queries_count\": 123,\n \"words_count\": 123,\n \"voice_seconds\": 123,\n \"premium_support\": true,\n \"default_plan\": false,\n \"remove_branding\": false,\n \"advanced_intents\": false,\n \"auto_intents\": false,\n \"billing_plan_group\": \"<string>\",\n \"credits\": {},\n \"attributes\": {},\n \"agency_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plan_lookup_key\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"bots_count\": 123,\n \"queries_count\": 123,\n \"words_count\": 123,\n \"voice_seconds\": 123,\n \"premium_support\": true,\n \"default_plan\": false,\n \"remove_branding\": false,\n \"advanced_intents\": false,\n \"auto_intents\": false,\n \"billing_plan_group\": \"<string>\",\n \"credits\": {},\n \"attributes\": {},\n \"agency_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plan_lookup_key\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/agency/billing/{agency_id}/billing_plan?api_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"bots_count\": 123,\n \"queries_count\": 123,\n \"words_count\": 123,\n \"voice_seconds\": 123,\n \"premium_support\": true,\n \"default_plan\": false,\n \"remove_branding\": false,\n \"advanced_intents\": false,\n \"auto_intents\": false,\n \"billing_plan_group\": \"<string>\",\n \"credits\": {},\n \"attributes\": {},\n \"agency_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"plan_lookup_key\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Data created successfully",
"meta": {},
"data": {
"name": "<string>",
"description": "<string>",
"bots_count": 123,
"queries_count": 123,
"words_count": 123,
"voice_seconds": 123,
"premium_support": true,
"default_plan": false,
"remove_branding": false,
"advanced_intents": false,
"auto_intents": false,
"billing_plan_group": "<string>",
"credits": {},
"attributes": {},
"agency_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"plan_lookup_key": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Your API KeyHTTPBearer
Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.
Path Parameters
Body
application/json
Was this page helpful?