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

# Update Recurring Invoice

> Update an existing recurring invoice



## OpenAPI

````yaml PUT /v1/recurring-invoices/{recurringInvoiceId}
openapi: 3.1.0
info:
  title: Blinksale API
  description: Official API for Blinksale - A modern invoicing solution
  version: 1.0.0
  contact:
    name: Blinksale Support
    url: https://blinksale.com/contact
    email: support@blinksale.com
servers:
  - url: https://app.blinksale.test/api
    description: Development server
  - url: https://blinksale.avenues.dev/api
    description: Staging server
  - url: https://app.blinksale.com/api
    description: Production server
security:
  - bearerAuth: []
tags:
  - name: Organizations
    description: Operations for managing organizations
  - name: Profile
    description: Operations for managing user profiles
  - name: Clients
    description: Operations for managing clients
  - name: Contacts
    description: Operations for managing client contacts
  - name: Estimates
    description: Operations for managing estimates
  - name: Invoices
    description: Operations for managing invoices
  - name: Payments
    description: Operations for managing payments
  - name: Recurring Invoices
    description: Operations for managing recurring invoices
  - name: Taxes
    description: Operations for managing tax rates
  - name: Units
    description: Operations for managing units of measurement
  - name: Saved Items
    description: Operations for managing saved items/products
  - name: Enums
    description: Operations for retrieving enumeration values
paths:
  /v1/recurring-invoices/{recurringInvoiceId}:
    put:
      tags:
        - Recurring Invoices
      summary: Update recurring invoice
      description: Updates an existing recurring invoice
      operationId: updateRecurringInvoice
      parameters:
        - name: recurringInvoiceId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The ID of the recurring invoice to update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                client_id:
                  type: string
                  format: uuid
                  example: 01jtbf0c9zaraqx3swthf88n5y
                name:
                  type: string
                  nullable: true
                  example: Monthly Hosting
                frequency:
                  type: string
                  example: MONTHLY
                start_date:
                  type: string
                  format: date
                  example: '2023-06-01'
                end_date:
                  type: string
                  format: date
                  nullable: true
                max_occurrences:
                  type: integer
                  nullable: true
                currency:
                  type: string
                  example: USD
                tax_id:
                  type: string
                  format: uuid
                  nullable: true
                  example: 01jtbf0c9zaraqx3swthf88n5y
                tax_distribution:
                  type: string
                  example: PER_DOCUMENT
                discount_type:
                  type: string
                  example: PERCENTAGE
                discount_value:
                  type: number
                  format: float
                  example: 0
                discount_distribution:
                  type: string
                  example: NO_DISCOUNT
                net_terms:
                  type: string
                  example: NET30
                has_late_fee:
                  type: boolean
                  example: true
                late_fee_kind:
                  type: string
                  example: PERCENTAGE
                late_fee_interval:
                  type: string
                  example: ONE_TIME
                late_fee:
                  type: number
                  format: float
                  example: 5
                shipping:
                  type: number
                  format: float
                  nullable: true
                  example: 0
                notes:
                  type: string
                  nullable: true
                  example: Monthly hosting services
                options:
                  type: object
                  nullable: true
                template_items:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        nullable: true
                        example: 01jtbf0c9zaraqx3swthf88n5y
                      name:
                        type: string
                        example: Hosting Services
                      description:
                        type: string
                        nullable: true
                        example: Monthly hosting and maintenance
                      quantity:
                        type: number
                        format: float
                        example: 1
                      price:
                        type: number
                        format: float
                        example: 99
                      unit_of_measurement_id:
                        type: string
                        format: uuid
                        nullable: true
                        example: 01jtbf0c9zaraqx3swthf88n5y
                      tax_id:
                        type: string
                        format: uuid
                        nullable: true
                        example: 01jtbf0c9zaraqx3swthf88n5y
                      tax_name:
                        type: string
                        nullable: true
                        example: Sales Tax
                      tax_percent:
                        type: number
                        format: float
                        nullable: true
                        example: 8.5
                      discount_type:
                        type: string
                        nullable: true
                        example: PERCENTAGE
                      discount_value:
                        type: number
                        format: float
                        nullable: true
                        example: 0
      responses:
        '200':
          description: Recurring invoice updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Recurring invoice updated successfully
                  data:
                    $ref: '#/components/schemas/RecurringInvoice'
        '400':
          description: Update failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Recurring invoice not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    RecurringInvoice:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        organization_id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        client_id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        name:
          type: string
          nullable: true
          example: Monthly Hosting
        frequency:
          type: string
          enum:
            - DAILY
            - WEEKLY
            - BIWEEKLY
            - MONTHLY
            - QUARTERLY
            - BIANNUALLY
            - ANNUALLY
          example: MONTHLY
        frequency_name:
          type: string
          example: Monthly
        status:
          type: string
          enum:
            - ACTIVE
            - PAUSED
            - COMPLETED
            - CANCELED
          example: ACTIVE
        status_name:
          type: string
          example: Active
        start_date:
          type: string
          format: date
          example: '2023-06-01'
        end_date:
          type: string
          format: date
          nullable: true
          example: null
        max_occurrences:
          type: integer
          nullable: true
          example: null
        occurrences:
          type: integer
          example: 3
        last_generated_date:
          type: string
          format: date
          nullable: true
          example: '2023-08-01'
        next_date:
          type: string
          format: date
          nullable: true
          example: '2023-09-01'
        client:
          $ref: '#/components/schemas/Client'
        template:
          type: object
          properties:
            id:
              type: string
              format: uuid
              example: 01jtbf0c9zaraqx3swthf88n5y
            currency:
              type: string
              example: USD
            tax_id:
              type: string
              format: uuid
              nullable: true
              example: 01jtbf0c9zaraqx3swthf88n5y
            tax_name:
              type: string
              nullable: true
              example: Sales Tax
            tax_percent:
              type: number
              format: float
              nullable: true
              example: 8.5
            tax_distribution:
              type: string
              enum:
                - NO_TAX
                - PER_ITEM
                - PER_DOCUMENT
              example: PER_DOCUMENT
            discount_type:
              type: string
              enum:
                - PERCENTAGE
                - FIXED
              nullable: true
              example: PERCENTAGE
            discount_value:
              type: number
              format: float
              nullable: true
              example: 10
            discount_distribution:
              type: string
              enum:
                - NO_DISCOUNT
                - PER_ITEM
                - PER_DOCUMENT
              example: PER_DOCUMENT
            net_terms:
              type: string
              enum:
                - IMMEDIATELY
                - NET15
                - NET30
                - NET45
                - NET60
                - OTHER
              example: NET30
            has_late_fee:
              type: boolean
              example: true
            late_fee_kind:
              type: string
              enum:
                - PERCENTAGE
                - FIXED
              nullable: true
              example: PERCENTAGE
            late_fee_interval:
              type: string
              enum:
                - ONE_TIME
                - DAILY
                - WEEKLY
                - MONTHLY
              nullable: true
              example: ONE_TIME
            late_fee:
              type: number
              format: float
              nullable: true
              example: 5
            shipping:
              type: number
              format: float
              nullable: true
              example: 15
            notes:
              type: string
              nullable: true
              example: Monthly hosting services.
            options:
              type: object
              nullable: true
            items:
              type: array
              items:
                $ref: '#/components/schemas/LineItem'
        is_due_for_generation:
          type: boolean
          example: false
        can_generate_invoices:
          type: boolean
          example: true
        is_editable:
          type: boolean
          example: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: An error occurred
        errors:
          type: object
          description: Validation errors by field
          example:
            email:
              - The email field is required.
    ValidationError:
      type: object
      required:
        - success
        - message
        - errors
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Validation error
        errors:
          type: object
          description: Validation errors by field
          example:
            email:
              - The email field must be a valid email address.
    Client:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        name:
          type: string
          example: Acme Inc
        email:
          type: string
          format: email
          example: billing@acme.com
        kind:
          type: string
          enum:
            - BUSINESS
            - PERSON
          example: BUSINESS
        kind_name:
          type: string
          example: Business
        profile:
          type: object
          nullable: true
          properties:
            company_name:
              type: string
              example: Acme Inc
            website:
              type: string
              example: https://acme.com
        address:
          $ref: '#/components/schemas/Address'
        document_defaults:
          type: object
          nullable: true
          properties:
            currency:
              type: string
              example: USD
        contact_count:
          type: integer
          example: 3
        note_count:
          type: integer
          example: 2
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    LineItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        organization_id:
          type: string
          format: uuid
          example: 01jtbf0c9zaraqx3swthf88n5y
        name:
          type: string
          example: Consulting Services
        description:
          type: string
          nullable: true
          example: Professional consulting services
        quantity:
          type: number
          format: float
          example: 10
        price:
          type: number
          format: float
          example: 150
        unit_of_measurement_id:
          type: string
          format: uuid
          nullable: true
          example: 01jtbf0c9zaraqx3swthf88n5y
        unit_name:
          type: string
          nullable: true
          example: Hour
        tax_id:
          type: string
          format: uuid
          nullable: true
          example: 01jtbf0c9zaraqx3swthf88n5y
        tax_name:
          type: string
          nullable: true
          example: Sales Tax
        tax_percent:
          type: number
          format: float
          nullable: true
          example: 8.5
        discount_type:
          type: string
          enum:
            - PERCENTAGE
            - FIXED
          nullable: true
          example: PERCENTAGE
        discount_value:
          type: number
          format: float
          nullable: true
          example: 10
        subtotal:
          type: number
          format: float
          example: 1500
        tax_amount:
          type: number
          format: float
          example: 127.5
        total:
          type: number
          format: float
          example: 1627.5
    Address:
      type: object
      nullable: true
      properties:
        line1:
          type: string
          example: 123 Main St
        line2:
          type: string
          nullable: true
          example: Suite 101
        city:
          type: string
          example: San Francisco
        state:
          type: string
          example: CA
        zip:
          type: string
          example: '94107'
        country:
          type: string
          example: US
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token obtained from the /v1/auth/login endpoint

````