> ## Documentation Index
> Fetch the complete documentation index at: https://yn-c9bb3266.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Installment Plan

> Retrieves a specific installment plan by ID.



## OpenAPI

````yaml GET /v1/installments-plans/{installments_plan_id}
openapi: 3.1.0
info:
  title: Yuno Payments API
  description: >-
    Yuno payment orchestration platform — unified REST API for payments,
    checkout sessions, customers, payment methods, subscriptions, payouts,
    marketplace transfers, and banking connectivity across Latin America.
  version: 1.0.0
  contact:
    name: Yuno Support
    email: support@y.uno
    url: https://docs.y.uno
  license:
    name: Proprietary
    url: https://y.uno
servers:
  - url: https://api-sandbox.y.uno
    description: Sandbox
  - url: https://api.y.uno
    description: Production
security:
  - publicApiKey: []
    privateSecretKey: []
paths:
  /v1/installments-plans/{installments_plan_id}:
    get:
      tags:
        - Installments Plans
      summary: Get installment plan
      description: Retrieves a specific installment plan by ID.
      operationId: getInstallmentsPlan
      parameters:
        - name: installments_plan_id
          in: path
          required: true
          description: The unique identifier of the installment plan
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Installment plan details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallmentsPlan'
        '404':
          description: Installment plan not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    InstallmentsPlan:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique installment plan identifier
          example: 3e599453-e147-4d1c-8643-73e4d980c2ae
        name:
          type: string
          example: Standard Plan
        account_id:
          type: array
          items:
            type: string
            format: uuid
          example:
            - 1a3a576a-01d0-40ff-a68e-494f82145773
        merchant_reference:
          type: string
          example: 001 08 Agosto 2023
        installments_plan:
          type: array
          items:
            type: object
            properties:
              installment:
                type: integer
              rate:
                type: number
        brand:
          type: string
          nullable: true
        iin:
          type: string
          nullable: true
        country_code:
          type: string
          example: BR
        first_installment_deferral:
          type: integer
          description: Number of periods before first installment
          example: 1
        amount:
          type: object
          properties:
            Currency:
              type: string
            min_value:
              type: number
            max_value:
              type: number
      example:
        id: 3e599453-e147-4d1c-8643-73e4d980c2ae
        name: Standard Plan
        account_id:
          - 1a3a576a-01d0-40ff-a68e-494f82145773
        merchant_reference: 001 08 Agosto 2023
        installments_plan:
          - installment: 1
            rate: 1
          - installment: 2
            rate: 1.294
          - installment: 12
            rate: 1.525
        brand: null
        iin: null
        country_code: BR
        first_installment_deferral: 1
        amount:
          Currency: BRL
          min_value: 0
          max_value: 10000000000
    Error:
      type: object
      description: >-
        Standard error envelope returned by every Yuno service for any 4xx or
        5xx response. Top level. `code` is a stable SCREAMING_SNAKE_CASE
        identifier. `messages` is always an array of strings, even when there is
        only one entry. There is no `error` wrapper, no singular `message`, no
        `type`, no `details`. See the Error handling guide for the full code
        catalog.
      required:
        - code
        - messages
      properties:
        code:
          type: string
          description: >-
            Stable, machine readable identifier. Branch on this in your client.
            Common values include `BAD_REQUEST`, `VALIDATION_ERROR`,
            `INVALID_REQUEST`, `UNAUTHORIZED`, `FORBIDDEN`, `NOT_FOUND`,
            `TOO_MANY_REQUESTS`, `INTERNAL_ERROR`, `BAD_GATEWAY`,
            `SERVICE_UNAVAILABLE`, plus business codes like
            `CUSTOMER_ID_DUPLICATED`, `RECIPIENT_NOT_FOUND`, `INVALID_STATE`,
            and the `PROVIDER_*` family for downstream provider errors.
          example: VALIDATION_ERROR
        messages:
          type: array
          description: >-
            Human readable details. Validation errors put one entry per failed
            field, formatted `"fieldName message"`.
          items:
            type: string
          example:
            - merchant_customer_id must not be blank
      example:
        code: VALIDATION_ERROR
        messages:
          - amount must be greater than 0
          - country must not be blank
  securitySchemes:
    publicApiKey:
      type: apiKey
      in: header
      name: public-api-key
      description: Your public API key from the Yuno Dashboard
    privateSecretKey:
      type: apiKey
      in: header
      name: private-secret-key
      description: Your private secret key (server-side only)

````