curl --request PUT \
--url https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"locationIds": [
"rrHDPw5RIR5ULeUlfSAR",
"q8LmVt2ZzYQ4pWnKdRb1"
],
"enabled": true
}'import requests
url = "https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard"
payload = {
"locationIds": ["rrHDPw5RIR5ULeUlfSAR", "q8LmVt2ZzYQ4pWnKdRb1"],
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({locationIds: ['rrHDPw5RIR5ULeUlfSAR', 'q8LmVt2ZzYQ4pWnKdRb1'], enabled: true})
};
fetch('https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard', 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.teamfollowup.ai/api/billing/sub-accounts/credit-guard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'locationIds' => [
'rrHDPw5RIR5ULeUlfSAR',
'q8LmVt2ZzYQ4pWnKdRb1'
],
'enabled' => true
]),
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://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard"
payload := strings.NewReader("{\n \"locationIds\": [\n \"rrHDPw5RIR5ULeUlfSAR\",\n \"q8LmVt2ZzYQ4pWnKdRb1\"\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"locationIds\": [\n \"rrHDPw5RIR5ULeUlfSAR\",\n \"q8LmVt2ZzYQ4pWnKdRb1\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"locationIds\": [\n \"rrHDPw5RIR5ULeUlfSAR\",\n \"q8LmVt2ZzYQ4pWnKdRb1\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"enabled": true,
"locationIds": [
"rrHDPw5RIR5ULeUlfSAR",
"q8LmVt2ZzYQ4pWnKdRb1"
],
"appliedCount": 2
}
}{
"success": false,
"error": "BadRequest",
"message": "body: Invalid input: expected boolean, received undefined"
}{
"success": false,
"error": "Unauthorized"
}{
"success": false,
"error": "InsufficientScope",
"message": "This API key does not have the required scope.",
"requiredScope": "billing:write"
}{
"success": false,
"error": "NotFound",
"message": "Some of these locationIds are not connected sub-accounts of this agency. Nothing was changed.",
"unknownLocationIds": [
"loc_other"
]
}{
"success": false,
"error": "SUB_ACCOUNT_WALLET_REQUIRED",
"message": "Some of these sub-accounts have no wallet yet, so Credit Guard cannot be set on them. Nothing was changed.",
"withoutWalletLocationIds": [
"q8LmVt2ZzYQ4pWnKdRb1"
]
}{
"success": false,
"error": "TooManyRequests"
}{
"success": false,
"error": "InternalError",
"message": "Could not load the rebilling change."
}{
"success": false,
"error": "PAYMENT_METHOD_PROVIDER_UNAVAILABLE",
"message": "Stripe could not verify your billing card. Nothing was charged; try again."
}Update Credit Guard for sub-accounts
Set Credit Guard on several sub-accounts at once. With Credit Guard on, a rebilled sub-account whose wallet is empty stops its own calls; with it off, your wallet pays for them.
All or nothing: every locationId must be one of your connected sub-accounts and already have a wallet, or nothing changes and the answer names the ones that did not qualify.
Needs a plan that includes rebilling, and Stripe Connect connected for the agency, even when turning something off. Without either the call changes nothing and answers CAPABILITY_NOT_AVAILABLE (403) or STRIPE_NOT_CONNECTED (409).
Allowed customer roles: agency_admin. The agency is the one the credential belongs to.
Required API key scope: billing:write.
curl --request PUT \
--url https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"locationIds": [
"rrHDPw5RIR5ULeUlfSAR",
"q8LmVt2ZzYQ4pWnKdRb1"
],
"enabled": true
}'import requests
url = "https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard"
payload = {
"locationIds": ["rrHDPw5RIR5ULeUlfSAR", "q8LmVt2ZzYQ4pWnKdRb1"],
"enabled": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({locationIds: ['rrHDPw5RIR5ULeUlfSAR', 'q8LmVt2ZzYQ4pWnKdRb1'], enabled: true})
};
fetch('https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard', 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.teamfollowup.ai/api/billing/sub-accounts/credit-guard",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'locationIds' => [
'rrHDPw5RIR5ULeUlfSAR',
'q8LmVt2ZzYQ4pWnKdRb1'
],
'enabled' => true
]),
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://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard"
payload := strings.NewReader("{\n \"locationIds\": [\n \"rrHDPw5RIR5ULeUlfSAR\",\n \"q8LmVt2ZzYQ4pWnKdRb1\"\n ],\n \"enabled\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"locationIds\": [\n \"rrHDPw5RIR5ULeUlfSAR\",\n \"q8LmVt2ZzYQ4pWnKdRb1\"\n ],\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.teamfollowup.ai/api/billing/sub-accounts/credit-guard")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"locationIds\": [\n \"rrHDPw5RIR5ULeUlfSAR\",\n \"q8LmVt2ZzYQ4pWnKdRb1\"\n ],\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"enabled": true,
"locationIds": [
"rrHDPw5RIR5ULeUlfSAR",
"q8LmVt2ZzYQ4pWnKdRb1"
],
"appliedCount": 2
}
}{
"success": false,
"error": "BadRequest",
"message": "body: Invalid input: expected boolean, received undefined"
}{
"success": false,
"error": "Unauthorized"
}{
"success": false,
"error": "InsufficientScope",
"message": "This API key does not have the required scope.",
"requiredScope": "billing:write"
}{
"success": false,
"error": "NotFound",
"message": "Some of these locationIds are not connected sub-accounts of this agency. Nothing was changed.",
"unknownLocationIds": [
"loc_other"
]
}{
"success": false,
"error": "SUB_ACCOUNT_WALLET_REQUIRED",
"message": "Some of these sub-accounts have no wallet yet, so Credit Guard cannot be set on them. Nothing was changed.",
"withoutWalletLocationIds": [
"q8LmVt2ZzYQ4pWnKdRb1"
]
}{
"success": false,
"error": "TooManyRequests"
}{
"success": false,
"error": "InternalError",
"message": "Could not load the rebilling change."
}{
"success": false,
"error": "PAYMENT_METHOD_PROVIDER_UNAVAILABLE",
"message": "Stripe could not verify your billing card. Nothing was charged; try again."
}Authorizations
Send your API key as Authorization: Bearer YOUR_API_KEY.
Headers
Optional. A retry with the same key returns the first answer with idempotentReplay: true.
8 - 255Body
The sub-accounts and the setting.
