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

# Update a budget plan

> Rename a plan, change its accounts or method, or make it the default. Changing accounts or method changes every past month's numbers too. To stop a plan being the default, make another plan the default.



## OpenAPI

````yaml /api/v2/openapi.json patch /budget-plans/{id}
openapi: 3.0.3
info:
  title: Finta API v2
  version: 2.0.0
  description: >-
    DB-backed Finta API for users with storage mode enabled. Requires an API key
    or an OAuth access token, and an active subscription or free trial.


    ## Rate limits


    Rate limits are enforced per user based on subscription plan, separately
    from MCP. The free trial gets Standard limits, or Pro limits if you're
    trialing Pro:


    | Plan | Per minute | Per day |

    | --- | --- | --- |

    | Standard | 20 requests | 500 requests |

    | Pro | 60 requests | 2,000 requests |


    When a limit is exceeded, the API returns HTTP 429 with `error.code`
    `RATE_LIMITED` and a human-readable `message`. A `Retry-After` response
    header is included with the number of seconds until the window resets.
servers:
  - url: https://api.finta.io/v2
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Me
    description: Authenticated user
  - name: Health
    description: Service health
  - name: Bank Connections
    description: Bank connection resources
  - name: Accounts
    description: Account and balance history resources
  - name: Investments
    description: Securities, holdings, and investment transaction resources
  - name: Transactions
    description: Transaction resources
  - name: Categories
    description: Transaction category resources
  - name: Category Groups
    description: Category group resources
  - name: Rules
    description: Transaction rule resources
  - name: Budgets
    description: Budget plans, budgets, and budget status
paths:
  /budget-plans/{id}:
    patch:
      tags:
        - Budgets
      summary: Update a budget plan
      description: >-
        Rename a plan, change its accounts or method, or make it the default.
        Changing accounts or method changes every past month's numbers too. To
        stop a plan being the default, make another plan the default.
      operationId: updateBudgetPlanV2
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 100
          description: Plan id or name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BudgetPlanUpdateRequest'
      responses:
        '200':
          description: Updated plan and the fields that changed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetPlanUpdateResponse'
        '400':
          description: >-
            `BAD_REQUEST` for an invalid body, or `PLAN_NAME_TAKEN`,
            `INVALID_PLAN_NAME`, `NO_ACCOUNTS_SELECTED`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: Storage mode required or subscription inactive
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            `NOT_FOUND`. The plan, budget, category or account does not exist,
            or budgets are not enabled for this account yet. A bad plan lists
            the user's plan names in `message`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/responses/RateLimitedResponse'
components:
  schemas:
    BudgetPlanUpdateRequest:
      type: object
      additionalProperties: false
      minProperties: 1
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 100
        accountIds:
          type: array
          nullable: true
          minItems: 1
          items:
            type: string
            format: uuid
          description: Accounts the plan covers, or null for every account
        isDefault:
          type: boolean
          enum:
            - true
          description: Make this the default plan. The previous default loses the flag.
        method:
          type: string
          enum:
            - standard
            - envelope
          description: >-
            `standard` compares spending to a monthly plan. `envelope` plans
            only what the user assigns from Ready to Assign.
    BudgetPlanUpdateResponse:
      type: object
      required:
        - plan
        - fieldsChanged
      properties:
        plan:
          $ref: '#/components/schemas/BudgetPlanDetail'
        fieldsChanged:
          type: array
          items:
            type: string
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: STORAGE_MODE_REQUIRED
            message:
              type: string
    UnauthorizedResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: Missing or invalid Authorization header
    BudgetPlanDetail:
      allOf:
        - $ref: '#/components/schemas/BudgetPlan'
        - type: object
          required:
            - accountIds
            - budgetCount
          properties:
            accountIds:
              type: array
              items:
                type: string
                format: uuid
              description: >-
                The plan's accounts when `accountScope` is `Selected`, otherwise
                empty
            budgetCount:
              type: integer
    BudgetPlan:
      type: object
      required:
        - id
        - name
        - method
        - accountScope
        - isDefault
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        method:
          type: string
          enum:
            - standard
            - envelope
        accountScope:
          type: string
          enum:
            - All
            - Selected
        isDefault:
          type: boolean
  responses:
    RateLimitedResponse:
      description: Rate limit exceeded
      headers:
        Retry-After:
          description: Seconds until the rate-limit window resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: RATE_LIMITED
              message: Per-minute rate limit exceeded (standard plan)
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Finta API key from API settings, or an OAuth access token issued to an
        authorized app. Send either as `Authorization: Bearer <token>`.

````

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