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

# Listar assinaturas

> Histórico de assinaturas do produtor, paginado. Escopo: `subscriptions:read`.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/subscriptions/history
openapi: 3.0.3
info:
  title: Ticto API v2
  version: 2.0.0
  description: >-
    API pública da Ticto para criar produtos e ofertas e ler pedidos,
    assinaturas e saques. Autenticação por token Bearer com escopos granulares.
    Todo acesso é isolado ao produtor dono do token — por construção, não por
    checagem por endpoint.
servers:
  - url: https://api.ticto.cloud
    description: Produção (tokens ticto_live_)
  - url: https://sandbox.ticto.cloud
    description: Sandbox (tokens ticto_test_)
security:
  - bearerAuth: []
tags:
  - name: Produtos
    description: Criação e leitura de produtos.
  - name: Ofertas
    description: Criação e leitura de ofertas de um produto.
  - name: Pedidos
    description: Leitura de pedidos (paridade com a API v1).
  - name: Assinaturas
    description: Leitura de assinaturas (paridade com a API v1).
  - name: Saques
    description: Leitura de saques/cashouts (paridade com a API v1).
paths:
  /api/v2/subscriptions/history:
    get:
      tags:
        - Assinaturas
      summary: Listar assinaturas
      description: >-
        Histórico de assinaturas do produtor, paginado. Escopo:
        `subscriptions:read`.
      operationId: listSubscriptions
      parameters:
        - name: paginate
          in: query
          schema:
            type: integer
            default: 30
            maximum: 1000
          description: Itens por página.
      responses:
        '200':
          description: Histórico de assinaturas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionList'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - bearerAuth:
            - subscriptions:read
components:
  schemas:
    SubscriptionList:
      type: object
      description: >-
        Histórico de assinaturas, paginado. Envelope do paginador: `data` +
        `links` + `meta`.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionItem'
        links:
          $ref: '#/components/schemas/PaginatorLinks'
        meta:
          $ref: '#/components/schemas/PaginatorMeta'
    SubscriptionItem:
      type: object
      description: >-
        Um item do histórico de assinaturas (`GET /subscriptions/history`).
        Espelha o relatório de assinaturas da v1.
      properties:
        id:
          type: integer
        price:
          type: integer
          description: Valor da recorrência em centavos.
        affiliates:
          type: array
          items:
            type: object
        first_charge_price:
          type: integer
          nullable: true
          description: >-
            Valor da 1ª cobrança em centavos (quando difere do preço
            recorrente).
        currency:
          type: string
          example: BRL
        interval:
          type: integer
          description: Intervalo em dias entre cobranças.
          example: 30
        next_charge:
          type: string
          nullable: true
          description: Data da próxima cobrança.
        situation:
          type: string
          description: Situação da assinatura.
          example: active
        best_day_to_charge:
          type: integer
          nullable: true
        free_days:
          type: integer
          nullable: true
        max_charges:
          type: integer
          nullable: true
          description: Nº máximo de cobranças; null = infinito.
        successful_charges:
          type: integer
        failed_charges:
          type: integer
        is_smart_installment:
          type: boolean
        installments:
          type: integer
          nullable: true
        cancellation_requested_at:
          type: string
          nullable: true
        canceled_at:
          type: string
          nullable: true
        canceled_by:
          type: string
          nullable: true
          description: Nome de quem cancelou.
        payment_method:
          type: string
          example: credit_card
        offer:
          type: object
          properties:
            id:
              type: integer
            code:
              type: string
            name:
              type: string
        order:
          type: object
          properties:
            id:
              type: integer
            hash:
              type: string
            created_at:
              type: string
        product:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
            is_owner:
              type: boolean
        customer:
          type: object
          description: Dados do comprador (nome, e-mail, documento, telefone, endereço).
        transactions:
          type: array
          items:
            type: object
        histories:
          type: array
          items:
            type: object
        created_at:
          type: string
          example: 01/06/2026 14:32:10
        updated_at:
          type: string
          example: 01/06/2026 14:32:12
      example:
        id: 4410
        price: 12400
        affiliates: []
        first_charge_price: 0
        currency: BRL
        interval: 30
        next_charge: 01/07/2026
        situation: active
        best_day_to_charge: null
        free_days: 0
        max_charges: null
        successful_charges: 3
        failed_charges: 0
        is_smart_installment: false
        installments: null
        cancellation_requested_at: null
        canceled_at: null
        canceled_by: null
        payment_method: credit_card
        offer:
          id: 21
          code: O88AA1234
          name: Mensalidade
        order:
          id: 90720
          hash: TOP0106X1Y2Z3
          created_at: 01/04/2026 09:12:00
        product:
          id: 306
          name: Comunidade Premium
          is_owner: true
        customer:
          id: 9902
          name: Maria Souza
          email: maria@exemplo.com
          cpf: 987.654.321-00
          cnpj: null
          phones:
            - ddd: '11'
              ddi: '55'
              number: '999998888'
          zipcode: '01310100'
          street: Av. Paulista
          street_number: '1000'
          neighborhood: Bela Vista
          complement: ''
          city: São Paulo
          state: SP
          country: BR
        transactions:
          - id: 123999
            hash: TRX9M3K1LP
            status: authorized
            payment_method: credit_card
            paid_amount: 12400
            created_at: 01/06/2026 09:12:05
        histories:
          - id: 8801
            subscription_id: 4410
            type: charge
            status: paid
            reference_date: Junho 2026
            metadata: null
            created_at: 01/06/2026 09:12:05
        created_at: 01/04/2026 09:12:00
        updated_at: 01/06/2026 09:12:05
    PaginatorLinks:
      type: object
      properties:
        first:
          type: string
          nullable: true
        last:
          type: string
          nullable: true
        prev:
          type: string
          nullable: true
        next:
          type: string
          nullable: true
    PaginatorMeta:
      type: object
      description: >-
        Metadados de paginação dos endpoints de leitura (paginador do Laravel,
        paridade com a v1).
      properties:
        current_page:
          type: integer
        from:
          type: integer
          nullable: true
        to:
          type: integer
          nullable: true
        per_page:
          type: integer
        last_page:
          type: integer
        total:
          type: integer
        path:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
          example: insufficient_scope
        message:
          type: string
          example: 'Token is missing the required ability: orders:read.'
        request_id:
          type: string
          nullable: true
  responses:
    Unauthorized:
      description: Token ausente, inválido ou expirado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: Invalid or expired token.
            request_id: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token opaco no formato `ticto_live_...` (produção) ou `ticto_test_...`
        (sandbox). Enviado como `Authorization: Bearer <token>`.

````

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