---
title: "PATCH /v1/add-ons/{id}"
method: PATCH
path: "/v1/add-ons/{id}"
tags: ["AddOns"]
---

# PATCH /v1/add-ons/{id}

`PATCH /v1/add-ons/{id}`

## Request

- Base URL: `https://api.tokenbooks.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tokenbooks.io/v1/add-ons/{id}`
- Auth: API key in header `x-api-key`

## Path parameters

- `id` string, required: Add-on catalog ID

## Request body

- UpdateAddOnRequestDto
  - `displayName` string: Add-on display name
  - `description` string: Add-on description
  - `category` 'MODULE' | 'CAPACITY' | 'SERVICE': Add-on commercial category
  - `eligiblePlanIds` string[]: Subscription plan IDs allowed to purchase this add-on
  - `stripeProductId` string: Stripe product ID
  - `monthlyPriceId` string, nullable: Stripe price ID for monthly billing
  - `annualPriceId` string, nullable: Stripe price ID for annual billing
  - `oneTimePriceId` string, nullable: Stripe price ID for one-time billing
  - `featureIdsGranted` string[]: Feature IDs this add-on grants while it stays active
  - `limitTransactionsDelta` integer: Transaction limit increase per purchased unit
  - `limitUsersDelta` integer: User limit increase per purchased unit
  - `limitPortfoliosDelta` integer: Portfolio limit increase per purchased unit
  - `limitWalletsDelta` integer: Wallet limit increase per purchased unit
  - `maxQuantity` integer, nullable: Highest quantity one workspace may hold; null when unbounded
  - `salesApproved` boolean: Whether self-serve purchase is blocked and sales approval is required

## Response `200`

- AddOnResponseDto
  - `id` string, required: Add-on catalog ID
  - `displayName` string, required: Add-on display name
  - `description` string, required: Add-on description
  - `category` 'MODULE' | 'CAPACITY' | 'SERVICE', required: Add-on commercial category
  - `eligiblePlanIds` string[], required: Subscription plan IDs allowed to purchase this add-on
  - `stripeProductId` string, required: Stripe product ID
  - `monthlyPriceId` string, nullable, required: Stripe price ID for monthly billing
  - `annualPriceId` string, nullable, required: Stripe price ID for annual billing
  - `oneTimePriceId` string, nullable, required: Stripe price ID for one-time billing
  - `featureIdsGranted` string[], required: Feature IDs this add-on grants while it stays active
  - `limitTransactionsDelta` integer, required: Transaction limit increase per purchased unit
  - `limitUsersDelta` integer, required: User limit increase per purchased unit
  - `limitPortfoliosDelta` integer, required: Portfolio limit increase per purchased unit
  - `limitWalletsDelta` integer, required: Wallet limit increase per purchased unit
  - `maxQuantity` integer, nullable, required: Highest quantity one workspace may hold; null when unbounded
  - `salesApproved` boolean, required: Whether self-serve purchase is blocked and sales approval is required
  - `createdAt` string, date-time, required: Creation timestamp (ISO 8601)
  - `updatedAt` string, date-time, required: Last update timestamp (ISO 8601)

---

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