---
title: "Create addon"
method: POST
path: "/addons/"
tags: ["Billing"]
---

# Create addon

`POST /addons/`

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Request body

- Addon
  - `id` string
  - `name` string, required
  - `description` string, required
  - `sku` string, nullable
  - `currency` string, required
  - `amount` number, required
  - `apply_scheme` 'one_time' | 'recurring'
  - `duration_times` integer, nullable
  - `unit_label` string, nullable
  - `status` 'active' | 'archived'
  - `archived` string, date-time, nullable
  - `created` string, date-time
  - `updated` string, date-time

## Response `201`

Addon created.

- Addon
  - `id` string
  - `name` string, required
  - `description` string, required
  - `sku` string, nullable
  - `currency` string, required
  - `amount` number, required
  - `apply_scheme` 'one_time' | 'recurring'
  - `duration_times` integer, nullable
  - `unit_label` string, nullable
  - `status` 'active' | 'archived'
  - `archived` string, date-time, nullable
  - `created` string, date-time
  - `updated` string, date-time

## Other responses

- `400` — Request body or query parameters failed validation.

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/revisions/70cbc827dc7b/schema)