---
title: "Patch add-ons"
method: PATCH
path: "/add-ons"
tags: ["Add-Ons"]
---

# Patch add-ons

`PATCH /add-ons`

## Request

- Base URL: `https://api.helcim.com/v2`
- URL: `https://api.helcim.com/v2/add-ons`
- Auth: none declared. Required headers: `api-token`

Partially update one or more existing add-ons.

## Headers

- `api-token` string, required

## Request body

- AddOnPatchReq
  - `addOns` BaseAddOnPatch[]
    - `id` integer, required: The add-on id to update
    - `name` string: The new add-on name. All add-ons must have a name between 3 and 256 characters in length.
    - `description` string: Additional information pertaining to the add-on
    - `amount` number, float: The amount charged to subscriptions which apply this add-on. This amount is charged for each copy of the add-on applied. For example an add-on with a quantity of three will charge this amount three times for the given subscription recurring billing.
    - `isQuantityEditable` 'false' | 'true'

## Response `200`

Successful add-on patch. The response body contains the data representation of all updated  add-ons.

- AddOnPatchRes
  - `data` BaseAddOn[]
    - `id` integer
    - `dateCreated` string, date-time
    - `dateUpdated` string, date-time
    - `name` string
    - `description` string
    - `amount` number, float
    - `frequency` string
    - `isQuantityEditable` string

## Other responses

- `400`: You are initiating a request with invalid parameter and/or body values.
- `401`: You are not authorized to access this resource. Please ensure that you are authenticated, and that you are using the `api-token` header
- `403`: You do not have permission to access this resource. Please ensure you are both authenticated and that you have the required roles/permissions active.
- `500`: Helcim internal server error encountered.

---

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