Obter status de faturamento
curl --request GET \
--url https://api.truthlocks.com/v1/billing/status \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.truthlocks.com/v1/billing/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/billing/status"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/billing/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"plan": "<string>",
"status": "<string>",
"trial_ends_at": "<string>"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Faturamento
Obter status de faturamento
Retorna o estado de faturamento atual, modo de recurso e período de carência para o locatário autenticado.
GET
/
v1
/
billing
/
status
Obter status de faturamento
curl --request GET \
--url https://api.truthlocks.com/v1/billing/status \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.truthlocks.com/v1/billing/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/billing/status"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/billing/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"plan": "<string>",
"status": "<string>",
"trial_ends_at": "<string>"
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}GET /v1/billing/status
feature_mode é NORMAL e grace_until é null. Se um pagamento falhar, a conta entra em um fluxo de trabalho de acesso gradual — Degradado, Restrito, depois Suspenso — com um período de carência em cada etapa.
Resposta
O nível atual de capacidade de recursos:
NORMAL— todos os recursos disponíveisDEGRADED— pagamento falhou; todos os recursos ainda funcionam durante o período de carênciaRESTRICTED— período de carência acabando; operações de escrita (cunhagem, criação de chave) estão desativadasSUSPENDED— período de carência expirado; todo o acesso à API está desativado até que o pagamento seja resolvido
Carimbo de data/hora ISO 8601 para quando o período de carência atual termina, ou
null se a conta estiver em situação regular.Uma mensagem legível descrevendo a ação necessária, ou
null quando nenhuma ação é necessária.Quando usar este endpoint
UseGET /v1/billing/status para:
- Exibir avisos de pagamento — verifique
feature_modena inicialização do aplicativo ou no login e mostre um banner quando o valor for diferente deNORMAL. - Proteger operações de escrita — antes de cunhar ou criar chaves, verifique se
feature_modenão éRESTRICTEDouSUSPENDED. - Acompanhar prazos de carência — leia
grace_untilpara mostrar aos seus usuários exatamente quanto tempo eles têm para resolver um problema de pagamento.
const res = await fetch("https://api.truthlocks.com/v1/billing/status", {
headers: { "X-API-Key": "tl_live_..." },
});
const { feature_mode, grace_until } = await res.json();
if (feature_mode !== "NORMAL") {
showPaymentBanner(feature_mode, grace_until);
}
Tempo de período de carência
As janelas de carência padrão para o modo de contrato Padrão são:| Transição | Janela de carência | Notificações |
|---|---|---|
| NORMAL → DEGRADADO | 7 dias | Lembretes em T+24h, T+48h, T+72h |
| DEGRADADO → RESTRITO | 14 dias | Lembretes em T+24h, T+48h, T+72h |
| RESTRITO → SUSPENSO | Imediato | Aviso final de suspensão |
Consulte falhas de pagamento e períodos de carência para uma análise completa do fluxo de trabalho de acesso gradual.

