Clients
Suspend client
Cancels the Stripe subscription (at period end) and marks the client as suspended. Only active clients can be suspended.
POST
/
public
/
api
/
v1
/
clients
/
{clientPublicId}
/
suspend
Suspend client
curl --request POST \
--url https://api.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"reason": "Customer requested cancellation pending refund review."
}
'import requests
url = "https://api.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend"
payload = { "reason": "Customer requested cancellation pending refund review." }
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({reason: 'Customer requested cancellation pending refund review.'})
};
fetch('https://api.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend', 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.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend",
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([
'reason' => 'Customer requested cancellation pending refund review.'
]),
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.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend"
payload := strings.NewReader("{\n \"reason\": \"Customer requested cancellation pending refund review.\"\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.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Customer requested cancellation pending refund review.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend")
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 \"reason\": \"Customer requested cancellation pending refund review.\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"creditsBalance": 123,
"creditsUsedThisPeriod": 123,
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"extraCreditsBalance": 123,
"nextCreditRenewalAt": "2023-11-07T05:31:56Z",
"pendingInvitations": [
{
"createdAt": "2023-11-07T05:31:56Z",
"email": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": true,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"pendingPlan": {
"currency": "<string>",
"effectiveAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"plan": {
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsLimit": 123,
"unlimitedCredits": true,
"users": [
{
"completedOnboarding": true,
"email": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"usersCount": 123,
"workspaceName": "<string>"
}{
"createdAt": "2023-11-07T05:31:56Z",
"creditsBalance": 123,
"creditsUsedThisPeriod": 123,
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"extraCreditsBalance": 123,
"nextCreditRenewalAt": "2023-11-07T05:31:56Z",
"pendingInvitations": [
{
"createdAt": "2023-11-07T05:31:56Z",
"email": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": true,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"pendingPlan": {
"currency": "<string>",
"effectiveAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"plan": {
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsLimit": 123,
"unlimitedCredits": true,
"users": [
{
"completedOnboarding": true,
"email": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"usersCount": 123,
"workspaceName": "<string>"
}{
"createdAt": "2023-11-07T05:31:56Z",
"creditsBalance": 123,
"creditsUsedThisPeriod": 123,
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"extraCreditsBalance": 123,
"nextCreditRenewalAt": "2023-11-07T05:31:56Z",
"pendingInvitations": [
{
"createdAt": "2023-11-07T05:31:56Z",
"email": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": true,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"pendingPlan": {
"currency": "<string>",
"effectiveAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"plan": {
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsLimit": 123,
"unlimitedCredits": true,
"users": [
{
"completedOnboarding": true,
"email": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"usersCount": 123,
"workspaceName": "<string>"
}{
"createdAt": "2023-11-07T05:31:56Z",
"creditsBalance": 123,
"creditsUsedThisPeriod": 123,
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"extraCreditsBalance": 123,
"nextCreditRenewalAt": "2023-11-07T05:31:56Z",
"pendingInvitations": [
{
"createdAt": "2023-11-07T05:31:56Z",
"email": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": true,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"pendingPlan": {
"currency": "<string>",
"effectiveAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"plan": {
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsLimit": 123,
"unlimitedCredits": true,
"users": [
{
"completedOnboarding": true,
"email": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"usersCount": 123,
"workspaceName": "<string>"
}Autorizações
Parâmetros de caminho
Corpo
application/json
Optional body describing why a client workspace is being suspended.
Structured cancellation reason for analytics/churn tracking.
Opções disponíveis:
customer_request, payment_failed, switching_provider, not_needed, price, feature_missing, other Free-form note explaining the suspension.
Maximum string length:
500Exemplo:
"Customer requested cancellation pending refund review."
Resposta
OK
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Opções disponíveis:
active, past_due, canceled, trialing, pending_onboarding, suspended Show child attributes
Show child attributes
Esta página foi útil?
Anterior
Remove client userSoft-deletes a user from the client workspace. Cannot remove the last admin. Returns 200 with the updated client (mirrors the internal controller).
Próximo
⌘I
Suspend client
curl --request POST \
--url https://api.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"reason": "Customer requested cancellation pending refund review."
}
'import requests
url = "https://api.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend"
payload = { "reason": "Customer requested cancellation pending refund review." }
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({reason: 'Customer requested cancellation pending refund review.'})
};
fetch('https://api.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend', 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.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend",
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([
'reason' => 'Customer requested cancellation pending refund review.'
]),
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.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend"
payload := strings.NewReader("{\n \"reason\": \"Customer requested cancellation pending refund review.\"\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.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"reason\": \"Customer requested cancellation pending refund review.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gennia.ai/public/api/v1/clients/{clientPublicId}/suspend")
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 \"reason\": \"Customer requested cancellation pending refund review.\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2023-11-07T05:31:56Z",
"creditsBalance": 123,
"creditsUsedThisPeriod": 123,
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"extraCreditsBalance": 123,
"nextCreditRenewalAt": "2023-11-07T05:31:56Z",
"pendingInvitations": [
{
"createdAt": "2023-11-07T05:31:56Z",
"email": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": true,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"pendingPlan": {
"currency": "<string>",
"effectiveAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"plan": {
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsLimit": 123,
"unlimitedCredits": true,
"users": [
{
"completedOnboarding": true,
"email": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"usersCount": 123,
"workspaceName": "<string>"
}{
"createdAt": "2023-11-07T05:31:56Z",
"creditsBalance": 123,
"creditsUsedThisPeriod": 123,
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"extraCreditsBalance": 123,
"nextCreditRenewalAt": "2023-11-07T05:31:56Z",
"pendingInvitations": [
{
"createdAt": "2023-11-07T05:31:56Z",
"email": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": true,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"pendingPlan": {
"currency": "<string>",
"effectiveAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"plan": {
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsLimit": 123,
"unlimitedCredits": true,
"users": [
{
"completedOnboarding": true,
"email": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"usersCount": 123,
"workspaceName": "<string>"
}{
"createdAt": "2023-11-07T05:31:56Z",
"creditsBalance": 123,
"creditsUsedThisPeriod": 123,
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"extraCreditsBalance": 123,
"nextCreditRenewalAt": "2023-11-07T05:31:56Z",
"pendingInvitations": [
{
"createdAt": "2023-11-07T05:31:56Z",
"email": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": true,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"pendingPlan": {
"currency": "<string>",
"effectiveAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"plan": {
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsLimit": 123,
"unlimitedCredits": true,
"users": [
{
"completedOnboarding": true,
"email": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"usersCount": 123,
"workspaceName": "<string>"
}{
"createdAt": "2023-11-07T05:31:56Z",
"creditsBalance": 123,
"creditsUsedThisPeriod": 123,
"currentPeriodEnd": "2023-11-07T05:31:56Z",
"currentPeriodStart": "2023-11-07T05:31:56Z",
"extraCreditsBalance": 123,
"nextCreditRenewalAt": "2023-11-07T05:31:56Z",
"pendingInvitations": [
{
"createdAt": "2023-11-07T05:31:56Z",
"email": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"isExpired": true,
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"pendingPlan": {
"currency": "<string>",
"effectiveAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"plan": {
"billingIntervalMonths": 123,
"creditsIncluded": 123,
"currency": "<string>",
"name": "<string>",
"priceCents": 123,
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seatsLimit": 123,
"unlimitedCredits": true,
"users": [
{
"completedOnboarding": true,
"email": "<string>",
"lastSeenAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"role": "<string>"
}
],
"usersCount": 123,
"workspaceName": "<string>"
}