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

# Listar planos do Parcelado

> Obtenha uma lista dos planos do Parcelado Kiwify da loja. O período máximo entre o created_start e o created_end é de 90 dias.



## OpenAPI

````yaml get /scheduled-installments
openapi: 3.1.0
info:
  version: 1.0.0
  title: API Kiwify
  description: ''
servers:
  - url: https://public-api.kiwify.com/v1/
    description: base
security: []
tags:
  - name: Autenticação
  - name: Conta
  - name: Produtos
  - name: Vendas
  - name: Financeiro
  - name: Affiliados
  - name: Webhooks
  - name: Eventos
  - name: Parcelado
    description: Planos do Parcelado Kiwify (scheduled installments) — somente leitura.
paths:
  /scheduled-installments:
    get:
      tags:
        - Parcelado
      description: >-
        Obtenha uma lista dos planos do Parcelado Kiwify da loja. O período
        máximo entre o created_start e o created_end é de 90 dias.
      parameters:
        - name: page_size
          in: query
          description: Quantidade de itens por página (máximo 100).
          schema:
            type: string
        - name: page_number
          in: query
          description: Número da página.
          schema:
            type: string
        - name: created_start
          in: query
          description: >-
            Data inicial (YYYY-MM-DD), fuso America/Sao_Paulo. Exige
            created_end.
          schema:
            type: string
        - name: created_end
          in: query
          description: >-
            Data final (YYYY-MM-DD), fuso America/Sao_Paulo. Exige
            created_start.
          schema:
            type: string
        - name: product_id
          in: query
          description: Filtra por produto.
          schema:
            type: string
        - name: offer_id
          in: query
          description: Filtra por oferta.
          schema:
            type: string
        - name: payment_method
          in: query
          description: Filtra por método de pagamento.
          schema:
            type: array
            items:
              type: string
              enum:
                - pix
                - boleto
                - credit_card
        - name: status
          in: query
          description: Filtra por status do plano.
          schema:
            type: array
            items:
              type: string
              enum:
                - active
                - overdue
                - settled
                - paused
                - cancelled
        - name: customer
          in: query
          description: Filtra por nome ou e-mail do cliente.
          schema:
            type: string
      responses:
        '200':
          description: Lista de planos do Parcelado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse'
              examples:
                ScheduledInstallments:
                  summary: Exemplo de listagem
                  value:
                    pagination:
                      count: 1
                      page_number: 1
                      page_size: 10
                    data:
                      - id: b8f0c2b4-2f1e-4a2c-9d3a-1f2e3d4c5b6a
                        created_at: '2026-01-10T13:00:00.000Z'
                        status: active
                        payment_method: credit_card
                        installment_quantity: 12
                        installments:
                          paid: 3
                          total: 12
                        next_charge_date: '2026-04-10'
                        customer_access:
                          has_access: true
                        product:
                          id: c05a1348-059d-43d5-9856-06958f50db8a
                          name: Meu Produto
                        customer:
                          name: cliente 1
                          email: cliente1@mail.com
      security:
        - AccountIdHeader: []
          OAuth2:
            - scheduled_installments
components:
  schemas:
    PaginatedResponse:
      type: object
      properties:
        pagination:
          type: object
          properties:
            count:
              type: number
              example: 10
            page_number:
              type: number
              example: 1
            page_size:
              type: number
              example: 10
        data:
          type: array
          example: []
          items: {}
  securitySchemes:
    AccountIdHeader:
      type: apiKey
      in: header
      name: x-kiwify-account-id
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes:
            stats: stats
            products: products
            events: events
            sales: sales
            sales_refund: sales_refund
            financial: financial
            affiliates: affiliates
            webhooks: webhooks
            scheduled_installments: scheduled_installments

````