cURL
curl --request GET \
--url https://api.cakto.com.br/public_api/subscriptions/export/xlsx/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/subscriptions/export/xlsx/"
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/export/xlsx/', 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/export/xlsx/",
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/export/xlsx/")
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/export/xlsx/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/subscriptions/export/xlsx/");
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);
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "<string>",
"status": "<string>",
"current_period": "<string>",
"amount": "<string>",
"paid_payments_quantity": "<string>",
"retention": "<string>",
"paymentMethod": "<string>",
"customer": {
"name": "",
"email": "",
"birthDate": null,
"phone": "",
"docType": null,
"docNumber": ""
},
"productName": "<string>",
"offerId": "<string>",
"offerName": "<string>",
"next_payment_date": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z",
"recurrence_period": "<string>",
"quantity_recurrences": "<string>",
"trial_days": "<string>",
"max_retries": "<string>",
"retry_interval": -1,
"parent_order": ""
}
]
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Relatórios
Exportar Assinaturas (XLSX)
Baixe a base completa de assinaturas em Excel para análises e relatórios.
GET
/
public_api
/
subscriptions
/
export
/
xlsx
/
cURL
curl --request GET \
--url https://api.cakto.com.br/public_api/subscriptions/export/xlsx/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cakto.com.br/public_api/subscriptions/export/xlsx/"
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/export/xlsx/', 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/export/xlsx/",
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/export/xlsx/")
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/export/xlsx/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.cakto.com.br/public_api/subscriptions/export/xlsx/");
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);
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "<string>",
"status": "<string>",
"current_period": "<string>",
"amount": "<string>",
"paid_payments_quantity": "<string>",
"retention": "<string>",
"paymentMethod": "<string>",
"customer": {
"name": "",
"email": "",
"birthDate": null,
"phone": "",
"docType": null,
"docNumber": ""
},
"productName": "<string>",
"offerId": "<string>",
"offerName": "<string>",
"next_payment_date": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z",
"recurrence_period": "<string>",
"quantity_recurrences": "<string>",
"trial_days": "<string>",
"max_retries": "<string>",
"retry_interval": -1,
"parent_order": ""
}
]
}{
"detail": "As credenciais de autenticação não foram fornecidas."
}Escopo
read subscriptions
O que faz
Gera e retorna um arquivo Excel (.xlsx) com os dados das assinaturas da sua conta.
Utilize este endpoint para extrair a base completa de assinaturas e trabalhar com os dados em planilhas, relatórios de BI ou compartilhamentos internos.
Casos de uso
- Consolidar a base de assinaturas para relatórios financeiros
- Cruzar dados de assinaturas com outras fontes em planilhas
- Compartilhar listagens com times de suporte, financeiro ou jurídico
- Arquivar snapshots mensais da base recorrente
Filtros
O endpoint aceita os mesmos filtros de busca, status e situação atual disponíveis na listagem de assinaturas. Utilize-os para exportar apenas o segmento desejado.| Parâmetro | Descrição |
|---|---|
status | Filtra por status da assinatura (active, inactive, canceled, etc.) |
paymentMethod | Filtra pelo método de pagamento |
current_situation | Filtra por new (nova) ou renewed (já renovada) |
search | Busca por cliente, produto, oferta ou pedido |
Combine filtros antes de exportar para gerar relatórios segmentados. Por exemplo, exporte apenas assinaturas ativas com PIX para conciliação bancária.
Authorizations
Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.
Query Parameters
Filtra por moeda. Usa 'BRL' por padrão se não informado.
Valores múltiplos podem ser separados por vírgulas.
Número de resultados a serem retornados por página.
Which field to use when ordering the results.
Número da página a ser retornada.
Valores múltiplos podem ser separados por vírgulas.
A search term.
Valores múltiplos podem ser separados por vírgulas.
Was this page helpful?