---
title: "Toggle recurring expense"
method: PATCH
path: "/recurring-expenses/{id}/toggle"
tags: ["recurring expenses"]
---

# Toggle recurring expense

`PATCH /recurring-expenses/{id}/toggle`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/recurring-expenses/{id}/toggle`
- Auth: one of:
  - `bearer` (a scheme the document does not define)
  - HTTP bearer

Enable or disable a recurring expense

## Path parameters

- `id` string, required

## Request body

- object
  - `isActive` boolean

## Response `200`

Recurring expense toggled successfully

- object
  - `data` RecurringExpenseResponseDto
    - `id` string, required
    - `groupId` string, required
    - `description` string, required
    - `totalAmount` number, required
    - `currency` string, required
    - `createdBy` string, required
    - `frequency` 'daily' | 'weekly' | 'monthly' | 'yearly', required
    - `startDate` string, date-time, required
    - `endDate` string, date-time
    - `nextExecutionDate` string, date-time, required
    - `isActive` boolean, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `payers` RecurringExpensePayerResponseDto[], required
      - `id` string, required
      - `userId` string, required
      - `amount` number, required
      - `user` UserInfoDto, required
        - `id` string, required
        - `displayName` string, required
        - `email` string, required
    - `recipients` RecurringExpenseRecipientResponseDto[], required
      - `id` string, required
      - `userId` string, required
      - `amount` number, required
      - `user` UserInfoDto, required
        - `id` string, required
        - `displayName` string, required
        - `email` string, required
    - `group` GroupInfoDto
      - `id` string, required
      - `name` string, required
  - `success` boolean
  - `message` string

## Other responses

- `400`: Bad Request - Invalid input or validation failed
- `401`: Unauthorized - Authentication required or invalid token
- `403`: Forbidden - Insufficient permissions to access this resource
- `404`: Not Found - The requested resource does not exist
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/spliteo/apis/spliteo-api.md) · [All operations](https://skmtc.dev/spliteo/apis/spliteo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spliteo/apis/spliteo-api/revisions/bd9b84f4e407?raw)