---
title: "GET /v1/add-ons"
method: GET
path: "/v1/add-ons"
tags: ["AddOns"]
---

# GET /v1/add-ons

`GET /v1/add-ons`

## 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`
- Auth: API key in header `x-api-key`

## Query parameters

- `pageSize` integer: Requested number of resources to return. Oversized values are clamped to the route limit.
- `pageToken` string: Opaque token returned by the previous list response.
- `category` 'MODULE' | 'CAPACITY' | 'SERVICE': Filter by add-on commercial category
- `search` string: Search add-on ID, display name, or Stripe product ID

## Response `200`

- AddOnsListResponseDto
  - `data` AddOnResponseDto[], required
    - `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)
  - `pagination` object, required
    - `pageSize` integer, required: Items returned per page.
    - `nextPageToken` string: Opaque token for retrieving the next page.

---

[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)