---
title: "Create coupon"
method: POST
path: "/coupons/"
tags: ["Billing"]
---

# Create coupon

`POST /coupons/`

## Headers

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

## Request body

- Coupon
  - `id` string
  - `name` string, required
  - `amount` number, required
  - `currency` string, required
  - `discount_scheme` '%' | '$'
  - `duration_scheme` 'one_time' | 'forever' | 'limited'
  - `duration_times` integer, nullable — Required when `duration_scheme=limited`. Number of billing cycles.
  - `valid_until` string, date, nullable
  - `apply_on` 'line' | 'invoice'
  - `status` 'active' | 'archived'
  - `archived` string, date-time, nullable
  - `created` string, date-time
  - `updated` string, date-time

## Response `201`

Coupon created.

- Coupon
  - `id` string
  - `name` string, required
  - `amount` number, required
  - `currency` string, required
  - `discount_scheme` '%' | '$'
  - `duration_scheme` 'one_time' | 'forever' | 'limited'
  - `duration_times` integer, nullable — Required when `duration_scheme=limited`. Number of billing cycles.
  - `valid_until` string, date, nullable
  - `apply_on` 'line' | 'invoice'
  - `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)