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

# List subscriptions

> Lists the subscriptions of the account, with consolidated indicators in `stats`.



## OpenAPI

````yaml /openapi.yaml get /subscriptions
openapi: 3.0.3
info:
  title: Fincle API
  version: 1.0.0
  description: >-
    Fincle payments API: charges by Pix, credit card and boleto, subscriptions,
    transactions, refunds, infractions, notifications and transfers.
servers:
  - url: https://api.fincle.com.br
    description: Production server
security: []
tags:
  - name: Authentication
    description: Issuance of the access token from the API key.
  - name: Charges
    description: Creation of charges by Pix, credit card and boleto.
  - name: Subscriptions
    description: Recurring billing on credit card.
  - name: Transactions
    description: Retrieval and refund of transactions.
  - name: Refunds
    description: Refund requests submitted by payers.
  - name: Infractions and MED
    description: Pix infraction reports and the amounts blocked as a result.
  - name: Webhooks
    description: Registration of notification endpoints and tracking of deliveries.
  - name: Balance and transfers
    description: Balance, statement, fees and transfer of the amounts received.
paths:
  /subscriptions:
    get:
      tags:
        - Subscriptions
      summary: List subscriptions
      description: >-
        Lists the subscriptions of the account, with consolidated indicators in
        `stats`.
      operationId: listSubscriptions
      parameters:
        - schema:
            type: string
          in: query
          name: productId
          required: false
        - schema:
            type: integer
            exclusiveMinimum: true
            minimum: 0
          in: query
          name: offerId
          required: false
        - schema:
            type: string
            enum:
              - active
              - overdue
              - cancelled
              - failed
              - completed
          in: query
          name: status
          required: false
        - schema:
            type: string
          in: query
          name: search
          required: false
        - schema:
            type: string
            enum:
              - all
              - last_30_days
              - this_month
              - last_3_months
          in: query
          name: period
          required: false
        - schema:
            type: string
            format: date-time
          in: query
          name: dateFrom
          required: false
        - schema:
            type: string
            format: date-time
          in: query
          name: dateTo
          required: false
        - schema:
            type: integer
            exclusiveMinimum: true
            minimum: 0
            default: 1
          in: query
          name: page
          required: false
        - schema:
            type: integer
            exclusiveMinimum: true
            minimum: 0
            maximum: 100
            default: 20
          in: query
          name: limit
          required: false
      responses:
        '200':
          description: Request processed successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data: {}
                  stats:
                    type: object
                    properties:
                      activeSubscriptions:
                        type: number
                      monthlyRecurringRevenueInCents:
                        type: number
                      lifetimeValueInCents:
                        type: number
                      churnRate:
                        type: number
                      totalSubscriptions:
                        type: number
                      cancelledSubscriptions:
                        type: number
                    required:
                      - activeSubscriptions
                      - monthlyRecurringRevenueInCents
                      - lifetimeValueInCents
                      - churnRate
                      - totalSubscriptions
                      - cancelledSubscriptions
                    additionalProperties: false
                  pagination:
                    type: object
                    properties:
                      page:
                        type: number
                      limit:
                        type: number
                      total:
                        type: number
                      totalPages:
                        type: number
                    required:
                      - page
                      - limit
                      - total
                      - totalPages
                    additionalProperties: false
                required:
                  - success
                  - stats
                  - pagination
                additionalProperties: false
              example:
                success: true
                data:
                  - id: cmdh1m4q2000e1yjn7f2z9t5v
                    status: active
                    nextChargeAt: '2026-12-12T14:08:06.000Z'
                stats:
                  activeSubscriptions: 1
                  monthlyRecurringRevenueInCents: 19900
                  lifetimeValueInCents: 19900
                  churnRate: 0
                  totalSubscriptions: 1
                  cancelledSubscriptions: 0
                pagination:
                  page: 1
                  limit: 20
                  total: 1
                  totalPages: 1
        '401':
          description: Access token missing, invalid or expired.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                required:
                  - success
                  - message
              example:
                success: false
                message: Não autorizado
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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