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

# Listar faturas da assinatura

> Lista as faturas (cobranças) de uma assinatura, da mais recente para a mais antiga.
Por padrão devolve só as **pagas** (`status=authorized`). Use `status=all` para todas,
ou outro status (`refused`, `processing`, `waiting_payment`, `refunded`...).

Uma fatura é uma cobrança (`transaction`): a renovação reaproveita o pedido e gera uma
cobrança por ciclo. Os campos têm os mesmos nomes do payload dos webhooks
`transaction_created` / `transaction_updated`, para conciliar pelo `hash`.
Em pagamento com dois cartões o ciclo aparece em duas faturas (`is_card2`).

Inclui as cobranças de pedidos anteriores a uma troca de plano da mesma assinatura.
Os dados vêm do banco da Ticto, sem consulta ao gateway.

> O token `Authorization: Bearer` pode ser do **produtor** do pedido ou do **assinante**.
> Qualquer outro usuário recebe 404.




## OpenAPI

````yaml /api-reference/openapi.yaml get /financial/subscriptions/{subscription_code}/invoices
openapi: 3.0.3
info:
  title: Nexus
  version: 1.0.2
  description: >
    API para integração entre Ticto e clientes externos


    # Autenticação


    Para autenticar as solicitações aos endpoints descritos a seguir, por favor,
    siga os passos abaixo:


    1. **Solicite** seu cadastro como cliente através do e-mail
    **infraestrutura@ticto.com.br** para obter seu `client_id` e `token`.

    2. **Use** seu token e ID de cliente para fazer login no Nexus e obter seu
    `client_token`.

    3. **Em todas as outras requisições**, envie seu `client_token` no header
    como `X-Api-Client-Token`.

    4. **Crie** seus usuários na rota de criação de usuário. Para cada usuário,
    será retornado um `public_token` único.

    5. **Para endpoints que não estão em public.php**, adicione o `public_token`
    do usuário no cabeçalho **Authorization** utilizando o formato:

       ```http
       Authorization: Bearer {public_token}
       ```

    ## Restrição de origem


    O acesso a esta API não está disponível para todos os sellers. Seu uso é
    estritamente permitido para parceiros comerciais que a utilizarão em
    cenários específicos. Por este motivo, o acesso será restrito a endereços IP
    e domínios previamente informados por esses parceiros. Essa medida visa
    proporcionar um ambiente mais controlado e seguro para todos os nossos
    usuários e parceiros.


    ### O que isso significa para os desenvolvedores?


    - **Acesso Limitado:**
      Somente os IPs e domínios pré-autorizados poderão realizar chamadas à API. Qualquer tentativa de acesso de um IP ou domínio não listado será automaticamente rejeitada.

    - **Processo de Autorização:**
      Para garantir a continuidade do acesso à API sem interrupções, é essencial que os desenvolvedores enviem os endereços IP ou domínios que necessitam de acesso diretamente à nossa equipe de suporte.

    - **Como Solicitar Acesso:**
      Envie um e-mail para **liberacao@ticto.com.br** com o assunto _"Solicitação de Acesso à API de pagamentos"_, incluindo:
      - Nome da empresa ou do desenvolvedor
      - Endereços IP ou domínios a serem autorizados
      - Justificativa para o acesso
      - Informações de contato para eventuais esclarecimentos

    ## Alterações e/ou inclusão de novos domínios e IPs


    Recomendamos que solicitações de adição ou alteração de IPs/domínios sejam
    feitas o mais breve possível para garantir uma transição suave. Em casos de
    alterações, os domínios e/ou IPs anteriores serão imediatamente bloqueados
    após sua remoção.


    ## Suporte e Dúvidas


    Para dúvidas ou suporte adicional, entre em contato conosco através do
    e-mail **liberacao@ticto.com.br**. Estamos comprometidos em auxiliar neste
    processo e garantir a melhor experiência possível.
servers:
  - url: https://nexus.ticto.com.br/api/v1
    description: Produção
security: []
tags:
  - name: Autenticação
  - name: Configurações do Cliente
  - name: Usuários
  - name: Onboarding de usuário
  - name: Contas Bancárias
  - name: Faixas de Taxa
    description: >-
      Endpoints para consulta de faixas de taxa personalizadas e histórico de
      alterações.
  - name: Frete
  - name: Financeiro
  - name: PIX Automático
    description: >-
      Consulta, cancelamento e nova tentativa de cobrança de assinaturas com PIX
      Automático (débito recorrente autorizado pelo pagador).
  - name: Produtos
  - name: Integrações
  - name: 'Webhooks: Usuários'
    description: Eventos relacionados a cadastro e atualização de usuários.
  - name: 'Webhooks: Contas Bancárias'
    description: Eventos relacionados a contas bancárias dos sellers.
  - name: 'Webhooks: Produtos e Ofertas'
    description: Eventos relacionados a produtos, ofertas, afiliados e coprodutores.
  - name: 'Webhooks: Financeiro'
    description: Eventos de reembolso, saque e antecipação.
  - name: 'Webhooks: Faixas de Taxa'
    description: Eventos de criação, atualização e exclusão de faixas de taxa.
  - name: 'Webhooks: Pedidos'
    description: Eventos de criação e atualização de pedidos.
  - name: 'Webhooks: Cobranças'
    description: >-
      Eventos de criação e mudança de status de cobranças (transações), na
      primeira compra e nas renovações.
  - name: 'Webhooks: Assinaturas'
    description: Eventos do ciclo de vida de assinaturas, cobranças e trial.
paths:
  /financial/subscriptions/{subscription_code}/invoices:
    get:
      tags:
        - Financeiro
      summary: Listar faturas da assinatura
      description: >
        Lista as faturas (cobranças) de uma assinatura, da mais recente para a
        mais antiga.

        Por padrão devolve só as **pagas** (`status=authorized`). Use
        `status=all` para todas,

        ou outro status (`refused`, `processing`, `waiting_payment`,
        `refunded`...).


        Uma fatura é uma cobrança (`transaction`): a renovação reaproveita o
        pedido e gera uma

        cobrança por ciclo. Os campos têm os mesmos nomes do payload dos
        webhooks

        `transaction_created` / `transaction_updated`, para conciliar pelo
        `hash`.

        Em pagamento com dois cartões o ciclo aparece em duas faturas
        (`is_card2`).


        Inclui as cobranças de pedidos anteriores a uma troca de plano da mesma
        assinatura.

        Os dados vêm do banco da Ticto, sem consulta ao gateway.


        > O token `Authorization: Bearer` pode ser do **produtor** do pedido ou
        do **assinante**.

        > Qualquer outro usuário recebe 404.
      operationId: listSubscriptionInvoices
      parameters:
        - name: subscription_code
          in: path
          required: true
          description: Código da assinatura
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: >-
            Status da cobrança. Padrão `authorized` (pagas). `all` devolve
            todas.
          schema:
            type: string
            default: authorized
          example: all
        - name: per_page
          in: query
          required: false
          description: Itens por página (1 a 100)
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 15
        - name: page
          in: query
          required: false
          description: Página
          schema:
            type: integer
            minimum: 1
            default: 1
      responses:
        '200':
          description: Faturas retornadas com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseSubscriptionInvoices'
        '401':
          description: Não autorizado
        '404':
          description: Assinatura não encontrada ou não pertence ao usuário do token
        '422':
          description: Parâmetros de consulta inválidos
        '500':
          description: Erro interno do servidor
      security:
        - ApiClientToken: []
        - bearerAuth: []
components:
  schemas:
    ResponseSubscriptionInvoices:
      type: object
      properties:
        status:
          type: string
          example: success
        message:
          type: string
          example: Registro encontrado com sucesso
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionInvoice'
        meta:
          type: object
          properties:
            current_page:
              type: integer
              example: 1
            per_page:
              type: integer
              example: 15
            total:
              type: integer
              example: 7
            last_page:
              type: integer
              example: 1
    SubscriptionInvoice:
      type: object
      description: >
        Fatura (cobrança) de uma assinatura. Mesmos campos do payload de
        `transaction_updated`,

        para conciliar listagem e webhooks pelo `hash`.
      properties:
        hash:
          type: string
          description: Código público da cobrança
          example: TPC4A2F1503K9Z
        status:
          type: string
          description: Status da cobrança (`authorized` = paga)
          example: authorized
        payment_method:
          type: string
          example: credit_card
        paid_amount:
          type: integer
          nullable: true
          description: >-
            Valor pago em centavos. Em dois cartões é o valor parcial desta
            cobrança
          example: 19700
        is_card2:
          type: boolean
          description: '`true` na segunda cobrança de um pagamento em dois cartões'
          example: false
        occurrence:
          type: integer
          nullable: true
          description: Ciclo da recorrência
          example: 2
        gateway:
          type: string
          nullable: true
          example: autorizou
        subscription_code:
          type: string
          example: TS7QK4M2XJ9BVN5RLD3W
        order:
          type: object
          properties:
            hash:
              type: string
              description: Código público do pedido
              example: TOCA3F111503K9Z42QM
        created_at:
          type: string
          description: Criação da cobrança (dd/mm/YYYY HH:mm:ss)
          example: 25/02/2026 10:00:00
        updated_at:
          type: string
          description: Última atualização da cobrança (dd/mm/YYYY HH:mm:ss)
          example: 25/02/2026 10:05:12
  securitySchemes:
    ApiClientToken:
      type: apiKey
      in: header
      name: X-Api-Client-Token
      description: Token de autenticação do cliente obtido via endpoint /auth
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Token de autenticação do usuário (public_token) obtido na criação do
        usuário

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.