> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cakto.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Exportar Assinaturas (XLSX)

> Baixe a base completa de assinaturas em Excel para análises e relatórios.

#### Escopo

```bash theme={null}
    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                             |

<Tip>
  Combine filtros antes de exportar para gerar relatórios segmentados. Por exemplo, exporte apenas assinaturas ativas com PIX para conciliação bancária.
</Tip>


## OpenAPI

````yaml GET /public_api/subscriptions/export/xlsx/
openapi: 3.0.3
info:
  title: Cakto API
  version: 1.0.0
  description: Documentação da API pública do Cakto.
servers:
  - url: https://api.cakto.com.br
    description: Cakto API
security: []
paths:
  /public_api/subscriptions/export/xlsx/:
    get:
      tags:
        - subscriptions
      description: |-
        Public API for exporting subscriptions in XLSX format,
        inherits from SubscriptionExportXLSX.
      operationId: subscriptions_export_xlsx
      parameters:
        - in: query
          name: amount
          schema:
            type: number
        - in: query
          name: amount__gt
          schema:
            type: number
        - in: query
          name: amount__gte
          schema:
            type: number
        - in: query
          name: amount__lt
          schema:
            type: number
        - in: query
          name: amount__lte
          schema:
            type: number
        - in: query
          name: canceledAt
          schema:
            type: string
            format: date-time
        - in: query
          name: canceledAt__gt
          schema:
            type: string
            format: date-time
        - in: query
          name: canceledAt__gte
          schema:
            type: string
            format: date-time
        - in: query
          name: canceledAt__lt
          schema:
            type: string
            format: date-time
        - in: query
          name: canceledAt__lte
          schema:
            type: string
            format: date-time
        - in: query
          name: createdAt
          schema:
            type: string
            format: date-time
        - in: query
          name: createdAt__gt
          schema:
            type: string
            format: date-time
        - in: query
          name: createdAt__gte
          schema:
            type: string
            format: date-time
        - in: query
          name: createdAt__lt
          schema:
            type: string
            format: date-time
        - in: query
          name: createdAt__lte
          schema:
            type: string
            format: date-time
        - name: currency
          required: false
          in: query
          description: Filtra por moeda. Usa 'BRL' por padrão se não informado.
          schema:
            type: string
        - in: query
          name: current_period
          schema:
            type: integer
        - in: query
          name: current_period__gt
          schema:
            type: integer
        - in: query
          name: current_period__gte
          schema:
            type: integer
        - in: query
          name: current_period__lt
          schema:
            type: integer
        - in: query
          name: current_period__lte
          schema:
            type: integer
        - in: query
          name: current_situation
          schema:
            type: string
        - in: query
          name: id
          schema:
            type: array
            items:
              type: string
          description: Valores múltiplos podem ser separados por vírgulas.
          explode: false
          style: form
        - name: limit
          required: false
          in: query
          description: Número de resultados a serem retornados por página.
          schema:
            type: integer
        - in: query
          name: max_retries
          schema:
            type: integer
        - in: query
          name: max_retries__gt
          schema:
            type: integer
        - in: query
          name: max_retries__gte
          schema:
            type: integer
        - in: query
          name: max_retries__lt
          schema:
            type: integer
        - in: query
          name: max_retries__lte
          schema:
            type: integer
        - in: query
          name: next_payment_date
          schema:
            type: string
            format: date-time
        - in: query
          name: next_payment_date__gt
          schema:
            type: string
            format: date-time
        - in: query
          name: next_payment_date__gte
          schema:
            type: string
            format: date-time
        - in: query
          name: next_payment_date__lt
          schema:
            type: string
            format: date-time
        - in: query
          name: next_payment_date__lte
          schema:
            type: string
            format: date-time
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
        - name: page
          required: false
          in: query
          description: Número da página a ser retornada.
          schema:
            type: integer
        - in: query
          name: paid_payments_quantity
          schema:
            type: integer
        - in: query
          name: paid_payments_quantity__gt
          schema:
            type: integer
        - in: query
          name: paid_payments_quantity__gte
          schema:
            type: integer
        - in: query
          name: paid_payments_quantity__lt
          schema:
            type: integer
        - in: query
          name: paid_payments_quantity__lte
          schema:
            type: integer
        - in: query
          name: paymentMethod
          schema:
            type: array
            items:
              type: string
          description: Valores múltiplos podem ser separados por vírgulas.
          explode: false
          style: form
        - in: query
          name: quantity_recurrences
          schema:
            type: integer
        - in: query
          name: quantity_recurrences__gt
          schema:
            type: integer
        - in: query
          name: quantity_recurrences__gte
          schema:
            type: integer
        - in: query
          name: quantity_recurrences__lt
          schema:
            type: integer
        - in: query
          name: quantity_recurrences__lte
          schema:
            type: integer
        - in: query
          name: recurrence_period
          schema:
            type: integer
        - in: query
          name: recurrence_period__gt
          schema:
            type: integer
        - in: query
          name: recurrence_period__gte
          schema:
            type: integer
        - in: query
          name: recurrence_period__lt
          schema:
            type: integer
        - in: query
          name: recurrence_period__lte
          schema:
            type: integer
        - in: query
          name: retry_interval
          schema:
            type: integer
        - in: query
          name: retry_interval__gt
          schema:
            type: integer
        - in: query
          name: retry_interval__gte
          schema:
            type: integer
        - in: query
          name: retry_interval__lt
          schema:
            type: integer
        - in: query
          name: retry_interval__lte
          schema:
            type: integer
        - name: search
          required: false
          in: query
          description: A search term.
          schema:
            type: string
        - in: query
          name: status
          schema:
            type: array
            items:
              type: string
          description: Valores múltiplos podem ser separados por vírgulas.
          explode: false
          style: form
        - in: query
          name: trial_days
          schema:
            type: integer
        - in: query
          name: trial_days__gt
          schema:
            type: integer
        - in: query
          name: trial_days__gte
          schema:
            type: integer
        - in: query
          name: trial_days__lt
          schema:
            type: integer
        - in: query
          name: trial_days__lte
          schema:
            type: integer
        - in: query
          name: updatedAt
          schema:
            type: string
            format: date-time
        - in: query
          name: updatedAt__gt
          schema:
            type: string
            format: date-time
        - in: query
          name: updatedAt__gte
          schema:
            type: string
            format: date-time
        - in: query
          name: updatedAt__lt
          schema:
            type: string
            format: date-time
        - in: query
          name: updatedAt__lte
          schema:
            type: string
            format: date-time
      responses:
        '200':
          content:
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: '#/components/schemas/PaginatedSubscriptionExportList'
          description: ''
        '401':
          description: Request não autenticado devido à ausência ou invalidez do token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthenticatedError'
              examples:
                Token ausente ou inválido:
                  $ref: '#/components/examples/UnauthenticatedErrorExample'
      security:
        - OAuth Token: []
components:
  schemas:
    PaginatedSubscriptionExportList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionExport'
    UnauthenticatedError:
      type: object
      properties:
        detail:
          type: string
    SubscriptionExport:
      type: object
      properties:
        id:
          type: string
        status:
          type: string
        current_period:
          type: string
          title: Período Atual da Assinatura
        amount:
          type: string
          title: Valor
        retry_interval:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          title: Dias entre retentativas
          description: Intervalo entre retentativas de cobrança (dias)
        paid_payments_quantity:
          type: string
          title: Quantidade de pagamentos realizados
        retention:
          type: string
          title: Dias de retenção
        paymentMethod:
          type: string
          title: Método de Pagamento
        customer:
          type: string
          readOnly: true
          default:
            name: ''
            email: ''
            birthDate: null
            phone: ''
            docType: null
            docNumber: ''
        productName:
          type: string
          title: Produto
        offerId:
          type: string
          title: Id da Oferta
        offerName:
          type: string
          title: Oferta
        parent_order:
          type: string
          default: ''
          title: Venda Pai
        next_payment_date:
          type: string
          format: date-time
          title: Próximo pagamento
        createdAt:
          type: string
          format: date-time
          title: Data de Criação
        canceledAt:
          type: string
          format: date-time
          title: Data de Cancelamento
        recurrence_period:
          type: string
          title: Período de Recorrência (dias)
        quantity_recurrences:
          type: string
          title: Quantidade de Recorrências
        trial_days:
          type: string
          title: Dias de Teste
        max_retries:
          type: string
          title: Tentativas Máximas
      required:
        - amount
        - canceledAt
        - createdAt
        - current_period
        - customer
        - id
        - max_retries
        - next_payment_date
        - offerId
        - offerName
        - paid_payments_quantity
        - paymentMethod
        - productName
        - quantity_recurrences
        - recurrence_period
        - retention
        - status
        - trial_days
  examples:
    UnauthenticatedErrorExample:
      summary: Token ausente ou inválido
      description: Token ausente ou inválido
      value:
        detail: As credenciais de autenticação não foram fornecidas.
  securitySchemes:
    OAuth Token:
      type: http
      scheme: bearer
      in: header
      name: Authorization
      description: >-
        Token de autenticação do tipo `Bearer {access_token}`, onde
        `{access_token}` é o token obtido no fluxo de
        [autenticação](/authentication).

````