curl --request GET \
--url https://api.cakto.com.br/public_api/subscriptions/{id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/subscriptions/{id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/subscriptions/{id}/', 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.cakto.com.br/public_api/subscriptions/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/subscriptions/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/subscriptions/{id}/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/subscriptions/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"amount": "<string>",
"parent_order": "<string>",
"paymentMethod": "<string>",
"customer": "<string>",
"product": "<string>",
"offer": "<string>",
"orders": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": "active",
"current_period": -1,
"recurrence_period": -1,
"quantity_recurrences": -1,
"trial_days": -1,
"max_retries": -1,
"retry_interval": -1,
"paid_payments_quantity": -1,
"retention": "<string>",
"next_payment_date": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z"
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}{
"detail": "<string>"
}Recuperar uma Assinatura
Consulte os detalhes completos de uma assinatura específica pelo ID.
curl --request GET \
--url https://api.cakto.com.br/public_api/subscriptions/{id}/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/subscriptions/{id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cakto.com.br/public_api/subscriptions/{id}/', 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.cakto.com.br/public_api/subscriptions/{id}/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.cakto.com.br/public_api/subscriptions/{id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyHttpResponse<String> response = Unirest.get("https://api.cakto.com.br/public_api/subscriptions/{id}/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/subscriptions/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
{
"amount": "<string>",
"parent_order": "<string>",
"paymentMethod": "<string>",
"customer": "<string>",
"product": "<string>",
"offer": "<string>",
"orders": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"status": "active",
"current_period": -1,
"recurrence_period": -1,
"quantity_recurrences": -1,
"trial_days": -1,
"max_retries": -1,
"retry_interval": -1,
"paid_payments_quantity": -1,
"retention": "<string>",
"next_payment_date": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z"
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}{
"detail": "<string>"
}Escopo
read subscriptions
O que faz
Retorna todas as informações disponíveis de uma assinatura, incluindo status, método de pagamento, período atual, situação e dados do pedido de origem. Utilize este endpoint para validar o estado de uma assinatura antes de executar ações como pausa, cancelamento ou troca de método de pagamento.Casos de uso
- Consultar o status e detalhes de uma assinatura no suporte ao cliente
- Validar o estado da assinatura antes de executar uma ação
- Exibir informações da assinatura em painéis e integrações
- Rastrear o histórico e ciclo de cobrança de um cliente específico
Parâmetro
id (path) — Identificador único da assinatura retornado pela Cakto.
Erros
| Status | Descrição |
|---|---|
404 | Assinatura não encontrada ou não pertence ao contexto do token. |
id deve ser o identificador da assinatura, não do pedido de origem.Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Path Parameters
Response
Valor da Assinatura
^-?\d{0,8}(?:\.\d{0,2})?$Pedido de Origem da Assinatura
Método de pagamento utilizado na Assinatura
Produto vendido na Assinatura
Oferta vendida na Assinatura
Identificador único do pedido no sistema
Data e hora de criação
Data e hora da última atualização
Identificador único da Assinatura no sistema
255Status da Assinatura
active- Ativainactive- Inativacanceled- Canceladaexpired- Expiradapaused- Pausadatrial- Em período de teste
active, inactive, canceled, expired, paused, trial Número da recorrência atual. (ex: 1 = primeiro pagamento)
-2147483648 <= x <= 2147483647Quantidade de dias entre cada pagamento da assinatura
-2147483648 <= x <= 2147483647Quantidade vezes que a assinatura será cobrada
-2147483648 <= x <= 2147483647Quantidade de dias de teste gratuito da assinatura
-2147483648 <= x <= 2147483647Quantidade máxima de retentativas de cobrança em caso de falha
-2147483648 <= x <= 2147483647Intervalo entre retentativas de cobrança (dias)
-2147483648 <= x <= 2147483647Quantidade de pagamentos pagos para esta assinatura
-2147483648 <= x <= 2147483647Quantidade de tempo que a assinatura permaneceu ativa
Data e hora estimada do próximo pagamento
Data e hora em que a assinatura foi cancelada
Was this page helpful?