---
title: "Upsert billing coupon"
method: POST
path: "/billing/coupons"
tags: ["billing"]
---

# Upsert billing coupon

`POST /billing/coupons`

## Request body

- CreateCouponRequestBody
  - `amount_off` integer, required
  - `currency` string, nullable
  - `duration` string, required
  - `duration_in_months` integer, required
  - `external_id` string, required
  - `max_redemptions` integer, required
  - `name` string, required
  - `percent_off` number, double, required
  - `times_redeemed` integer, required

## Response `201`

Created

- object
  - `data` BillingCouponResponseData, required
    - `account_id` string, required
    - `amount_off` integer, nullable
    - `currency` string, nullable
    - `duration` string, nullable
    - `duration_in_months` integer, nullable
    - `environment_id` string, required
    - `external_id` string, required
    - `id` string, required
    - `is_active` boolean, required
    - `max_redemptions` integer, nullable
    - `metadata` object, required
    - `name` string, required
    - `percent_off` number, double, nullable
    - `provider_type` 'metronome' | 'orb' | 'schematic' | 'stripe', required
    - `times_redeemed` integer, required
    - `valid_from` string, date-time, nullable
    - `valid_until` string, date-time, nullable
  - `params` object, required — Input parameters

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Server error

## Changes

> 125 revisions in range; 38 could not be searched.

- **2026-06-25** `5eb95e8d48e1` — 1 breaking
  - the `percent_off` request property type/format changed from `number`/`` to `number`/`double`
- **2026-06-05** `c0d7b479cd11` — 1 warning
  - added the new `metronome` enum value to the `data/provider_type` response property for the response status `201`

[Change history](https://skmtc.dev/schematichq/apis/schematic-api/changes/billing/coupons/post.md)

---

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