Skip to main content
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>'
"<string>"

​
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âmetroDescrição
statusFiltra por status da assinatura (active, inactive, canceled, etc.)
paymentMethodFiltra pelo método de pagamento
current_situationFiltra por new (nova) ou renewed (já renovada)
searchBusca 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

​
Authorization
string
header
required

Token de autenticação do tipo Bearer {access_token}, onde {access_token} é o token obtido no fluxo de autenticação.

Response

Arquivo XLSX gerado com sucesso.

The response is of type file.