---
title: "List add-ons"
method: GET
path: "/api/v1/addons"
tags: ["Add-ons"]
---

# List add-ons

`GET /api/v1/addons`

## Query parameters

- `search` string
- `currency` string
- `include_archived` boolean
- `order_by` string
- `page` integer
- `per_page` integer

## Response `200`

List of add-ons

- AddOnListResponse
  - `data` AddOn[], required
    - `archived_at` string, date-time, nullable
    - `created_at` string, date-time, required
    - `description` string, nullable
    - `entitlements` Entitlement[]
      - `created_at` string, date-time, required
      - `feature_id` string, MeteroidId, required
      - `id` string, MeteroidId, required
      - `updated_at` string, date-time, required
      - `value` union, required
        - object
          - `enabled` boolean, required
          - `type` 'BOOLEAN', required
        - object
          - `enabled` boolean — Per-entitlement kill switch. `false` means disabled.
          - `limit` string, nullable — Cap on usage. Null means unlimited.
          - `overage_behavior` union, required — What happens past the limit.
            - object — Deny access once usage reaches the limit. Meteroid does not enforce this — your integration must check and act.
              - …
            - object — Keep serving usage past the limit; overage is billed or handled out-of-band.
              - …
          - `reset_period` union
            - object — Resets at the start of each subscription billing period.
              - …
            - object — Buckets aligned to the calendar (e.g. every 1st of the month), shared across customers.
              - …
            - object — Fixed-length buckets anchored on the subscription activation date. Resets at every boundary.
              - …
            - object — Continuous rolling window — usage older than the window edge drops out, no fixed reset.
              - …
            - object — Usage accumulates for the life of the subscription — no reset.
              - …
          - `type` 'METERED', required
          - `warning_threshold_pct` integer, nullable — Percentage of the Cap at which a warning triggers (0–100).
    - `fee_type` 'RATE' | 'SLOT' | 'CAPACITY' | 'USAGE' | 'EXTRA_RECURRING' | 'ONE_TIME'
    - `id` string, MeteroidId, required
    - `max_instances_per_subscription` integer, nullable
    - `name` string, required
    - `price_id` string, MeteroidId, required
    - `product_id` string, MeteroidId, required
    - `self_serviceable` boolean, required
  - `pagination_meta` PaginationResponse, required
    - `page` integer, required
    - `per_page` integer, required
    - `total_items` integer, required
    - `total_pages` integer, required

## Other responses

- `401` — Unauthorized
- `429` — Too many requests

## Changes

- **2026-05-18** (v1) `0cdc37620ffb` — 1 info
  - added the optional property `data/items/entitlements` to the response with the `200` status
- **2026-03-30** (v1) `5cb340234766` — 1 info
  - added the new optional `query` request parameter `order_by`
- **2026-03-27** (v1) `de35c02bb0d2` — 1 warning, 1 info
  - added the new `TOO_MANY_REQUESTS` enum value to the `code` response property for the response status `401`
  - added the non-success response with the status `429`
- **2026-03-20** (v1) `51c7018cc5ef` — 1 info
  - endpoint added
- **2025-07-09** (v1) `dece17f86f99` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/meteroid-oss/apis/meteroid/changes/api/v1/addons/get.md)

---

[API](https://skmtc.dev/meteroid-oss/apis/meteroid.md) · [All operations](https://skmtc.dev/meteroid-oss/apis/meteroid/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/meteroid-oss/meteroid/revisions/0cdc37620ffb/schema)