> ## Documentation Index > Fetch the complete documentation index at: https://docs.visorfinance.app/llms.txt > Use this file to discover all available pages before exploring further. # List installment plans > Returns the installment plans (parcelamentos) of a space, ordered by the date of the last installment, with the same progress and amounts the app shows. Plans on a hidden account are left out. By default it returns the plans still being paid (`status=active`); `status=completed` returns the plans the user marked as completed. Requires the `pfm:read` scope. ## OpenAPI ````yaml /openapi.json get /v1/spaces/{space_id}/installment-plans openapi: 3.0.3 info: description: >- Personal REST API for Visor Pro and Premium users. Authenticate with a personal API token created in Visor Settings, sent as `Authorization: Bearer visor_pat_...`, or with an OAuth access token from the Visor CLI browser login. title: Visor Personal API version: 1.0.0 servers: - url: https://api.visorfinance.app variables: {} security: - personal_api_token: [] - visor_cli_oauth: - pfm:read tags: [] paths: /v1/spaces/{space_id}/installment-plans: get: tags: - Installments summary: List installment plans description: >- Returns the installment plans (parcelamentos) of a space, ordered by the date of the last installment, with the same progress and amounts the app shows. Plans on a hidden account are left out. By default it returns the plans still being paid (`status=active`); `status=completed` returns the plans the user marked as completed. Requires the `pfm:read` scope. operationId: VisorWeb.Api.V1.InstallmentPlanController.index parameters: - description: A space `id` from `GET /v1/spaces` in: path name: space_id required: true schema: format: uuid type: string - description: Return only plans with this status. Defaults to `active`. in: query name: status required: false schema: default: active enum: - active - completed type: string responses: '200': content: application/json: example: data: - account_id: 0b7f6d2e-8c1a-4f3b-9d5e-6a2c4b8e1f90 category_id: 5d3a9c1e-2b4f-4e6a-8c7d-1f0e9b2a3c45 currency_code: BRL description: Notebook first_due_date: '2026-05-10' id: 3e8f1a52-7c4d-4b69-9a0e-5d2c8b7f1e34 installment_amount: '250' next_due_date: '2026-11-10' paid_installments: 5 remaining_amount: '1750' status: active total_amount: '3000' total_installments: 12 schema: $ref: '#/components/schemas/InstallmentPlanListResponse' description: Installment plans of the space headers: x-ratelimit-limit: description: Requests allowed for this token per minute schema: example: 60 type: integer style: simple x-ratelimit-remaining: description: Requests left for this token in the current minute schema: example: 59 type: integer style: simple x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '400': content: application/json: example: errors: - code: BAD_REQUEST details: parameter: include_hidden message: The request is malformed. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: A query parameter has an invalid value headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '401': content: application/json: example: errors: - code: INVALID_TOKEN details: {} message: The personal API token is not valid. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Missing, invalid, expired, or revoked token headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '403': content: application/json: example: errors: - code: INSUFFICIENT_SCOPE details: required_scope: pfm:read message: The personal API token does not grant this operation. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Pro or Premium plan required, or insufficient scope headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '404': content: application/json: example: errors: - code: NOT_FOUND details: {} message: The resource does not exist. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: The space does not exist or the token's user cannot access it headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '406': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: The client does not accept JSON headers: x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple '429': content: application/json: example: errors: - code: RATE_LIMITED details: retry_after_seconds: 42 message: >- Too many requests. Retry after the number of seconds in Retry-After. request_id: F8x2kQ9vXc1AAAAB schema: $ref: '#/components/schemas/ErrorResponse' description: Rate limit exceeded headers: retry-after: description: Seconds until the current window ends schema: example: 42 type: integer style: simple x-ratelimit-limit: description: Requests allowed for this token per minute schema: example: 60 type: integer style: simple x-ratelimit-remaining: description: Requests left for this token in the current minute schema: example: 59 type: integer style: simple x-request-id: description: Request identifier, also returned as `request_id` in errors schema: type: string style: simple callbacks: {} components: schemas: InstallmentPlanListResponse: additionalProperties: false properties: data: items: $ref: '#/components/schemas/InstallmentPlan' type: array required: - data title: InstallmentPlanListResponse type: object ErrorResponse: additionalProperties: false properties: errors: items: $ref: '#/components/schemas/Error' minItems: 1 type: array required: - errors title: ErrorResponse type: object InstallmentPlan: additionalProperties: false properties: account_id: description: >- The card account of the plan; null when the plan has no linked account format: uuid nullable: true type: string category_id: format: uuid nullable: true type: string currency_code: description: ISO 4217 code example: BRL type: string description: description: The name of the purchase type: string first_due_date: description: The date of the first installment format: date type: string id: format: uuid type: string installment_amount: description: The amount of one installment as a decimal string example: '250' format: decimal type: string next_due_date: description: >- The date of the next installment still to pay; null when none remains format: date nullable: true type: string paid_installments: description: The installments already paid (the `X` of `X de N`) type: integer remaining_amount: description: >- The amount still to pay as a decimal string; `0` for a completed plan example: '1750' format: decimal type: string status: description: '`completed` when the user marked the plan as completed' enum: - active - completed type: string total_amount: description: The amount of the whole purchase as a decimal string example: '3000' format: decimal type: string total_installments: description: The number of installments (the `N` of `X de N`) type: integer required: - id - description - account_id - installment_amount - total_amount - remaining_amount - currency_code - total_installments - paid_installments - first_due_date - next_due_date - status - category_id title: InstallmentPlan type: object Error: additionalProperties: false properties: code: description: Stable machine-readable code example: INVALID_TOKEN type: string details: additionalProperties: true description: Code-specific context type: object message: description: English text for developers type: string request_id: description: The x-request-id response header of the request nullable: true type: string required: - code - message - details - request_id title: Error type: object securitySchemes: personal_api_token: bearerFormat: visor_pat__ description: Personal API token created in Visor Settings scheme: bearer type: http visor_cli_oauth: description: >- OAuth 2.0 access token of the Visor CLI browser login (authorization code with PKCE). Only the first-party Visor CLI client can use it on this API. flows: authorizationCode: authorizationUrl: https://dashboard.visorfinance.app/oauth/authorize refreshUrl: https://dashboard.visorfinance.app/oauth/token scopes: pfm:read: Read financial data pfm:transactions:write: Create, edit, and delete transactions pix:payments:write: Start Pix payments that you confirm with biometrics at your bank tokenUrl: https://dashboard.visorfinance.app/oauth/token type: oauth2 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.