Billing
Open the billing portal
Generate a short-lived customer portal URL for a user’s personal billing or an organization’s team billing.
POST
/
api
/
v1
/
billing
/
portal
Open the billing portal
curl --request POST \
--url https://api.example.com/api/v1/billing/portal \
--header 'Content-Type: application/json' \
--data '
{
"scope": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/billing/portal"
payload = { "scope": "<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({scope: '<string>'})
};
fetch('https://api.example.com/api/v1/billing/portal', 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/billing/portal",
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([
'scope' => '<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/billing/portal"
payload := strings.NewReader("{\n \"scope\": \"<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/billing/portal")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/billing/portal")
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 \"scope\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyOpen the hosted billing portal so a user can update a saved card, view
invoices, or download receipts. Scope the portal to a personal billing
customer or to a team (organization) billing customer.
Authentication
Requires a Bearer token with thebilling scope. See
Authentication.
Body
string
"user" (default when personal) or "org" (default when the caller is
inside a team and holds manageBilling). Team scope additionally
requires the team to have a payment method already on file — callers
who try the team portal before funding billing get a 409
team_billing_setup_required error instead.Example
curl
curl -X POST "https://api.hitheo.ai/api/v1/billing/portal" \
-H "Authorization: Bearer $THEO_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "scope": "org" }'
SDK
const { portal_url } = await theo.billingPortal({ scope: "org" });
window.open(portal_url, "_blank");
Response
{
"portal_url": "https://portal.hitheo.ai/session/...",
"scope": "org"
}
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | org_context_required | Requested scope: "org" without an active team. |
| 403 | permission_denied | Caller lacks manageBilling in the active team. |
| 409 | team_billing_setup_required | Team has no payment method on file — run a checkout first. |
| 503 | billing_unavailable | Billing isn’t configured on this deployment. |
Was this page helpful?
Open the billing portal
curl --request POST \
--url https://api.example.com/api/v1/billing/portal \
--header 'Content-Type: application/json' \
--data '
{
"scope": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/billing/portal"
payload = { "scope": "<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({scope: '<string>'})
};
fetch('https://api.example.com/api/v1/billing/portal', 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/billing/portal",
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([
'scope' => '<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/billing/portal"
payload := strings.NewReader("{\n \"scope\": \"<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/billing/portal")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/billing/portal")
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 \"scope\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body