---
title: "Create an add-on"
method: POST
path: "/api/v1/addons"
tags: ["Add-ons"]
---

# Create an add-on

`POST /api/v1/addons`

## Request body

- CreateAddOnRequest
  - `description` string, nullable
  - `entitlements` EntitlementSpec[] — Inline entitlements to attach when creating this add-on.
    - `feature_id` string, MeteroidId, 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.
            - `grace_period_pct` integer, nullable
            - `type` 'BLOCK', required
          - object — Keep serving usage past the limit; overage is billed or handled out-of-band.
            - `type` 'ALLOW', required
        - `reset_period` union
          - object — Resets at the start of each subscription billing period.
            - `type` 'BILLING_CYCLE', required
          - object — Buckets aligned to the calendar (e.g. every 1st of the month), shared across customers.
            - `interval` integer, required
            - `type` 'CALENDAR', required
            - `unit` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
          - object — Fixed-length buckets anchored on the subscription activation date. Resets at every boundary.
            - `interval` integer, required
            - `type` 'FIXED_WINDOW', required
            - `unit` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
          - object — Continuous rolling window — usage older than the window edge drops out, no fixed reset.
            - `interval` integer, required
            - `type` 'SLIDING_WINDOW', required
            - `unit` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
          - object — Usage accumulates for the life of the subscription — no reset.
            - `type` 'NEVER', required
        - `type` 'METERED', required
        - `warning_threshold_pct` integer, nullable — Percentage of the Cap at which a warning triggers (0–100).
  - `max_instances_per_subscription` integer, nullable
  - `name` string, required
  - `price_id` string, MeteroidId, required
  - `product_id` string, MeteroidId, required
  - `self_serviceable` boolean

## Response `201`

Add-on created

- AddOn
  - `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.
            - `grace_period_pct` integer, nullable
            - `type` 'BLOCK', required
          - object — Keep serving usage past the limit; overage is billed or handled out-of-band.
            - `type` 'ALLOW', required
        - `reset_period` union
          - object — Resets at the start of each subscription billing period.
            - `type` 'BILLING_CYCLE', required
          - object — Buckets aligned to the calendar (e.g. every 1st of the month), shared across customers.
            - `interval` integer, required
            - `type` 'CALENDAR', required
            - `unit` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
          - object — Fixed-length buckets anchored on the subscription activation date. Resets at every boundary.
            - `interval` integer, required
            - `type` 'FIXED_WINDOW', required
            - `unit` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
          - object — Continuous rolling window — usage older than the window edge drops out, no fixed reset.
            - `interval` integer, required
            - `type` 'SLIDING_WINDOW', required
            - `unit` 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR', required
          - object — Usage accumulates for the life of the subscription — no reset.
            - `type` 'NEVER', required
        - `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

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `429` — Too many requests

## Changes

- **2026-05-18** (v1) `0cdc37620ffb` — 2 info
  - added the new optional request property `entitlements`
  - added the optional property `entitlements` to the response with the `201` status
- **2026-03-27** (v1) `de35c02bb0d2` — 2 warning, 1 info
  - added the new `TOO_MANY_REQUESTS` enum value to the `code` response property for the response status `400`
  - 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/post.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)