Skip to main content
POST
/
api
/
v1
/
coupons
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const coupon = await client.v1.coupons.create({
  id: 'id',
  amountsOff: [{ amount: 0, currency: 'usd' }],
  description: 'description',
  durationInMonths: 1,
  metadata: { foo: 'string' },
  name: 'name',
  percentOff: 1,
});

console.log(coupon.data);
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "percentOff": 50,
    "amountsOff": [
      {
        "amount": 123
      }
    ],
    "billingId": "<string>",
    "billingLinkUrl": "<string>",
    "durationInMonths": 2,
    "metadata": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Headers

​
X-ACCOUNT-ID
string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

​
X-ENVIRONMENT-ID
string

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Body

application/json

Create a coupon with percentage or fixed-amount discount.

​
id
string
required

The unique identifier for the entity

Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$
​
name
string
required

Name of the coupon

Maximum string length: 40
​
description
string | null
required

Description of the coupon

Maximum string length: 255
​
percentOff
number | null
required

Percentage discount off the original price

Required range: 1 <= x <= 100
​
amountsOff
Money · object[] | null
required

Fixed amount discounts in different currencies

Minimum array length: 1
​
durationInMonths
integer | null
required

Duration of the coupon validity in months

Required range: x >= 1
​
metadata
object
required

Metadata associated with the entity

Response

The newly created coupon object.

Response object

​
data
Coupon · object
required

Discount instrument with percentage or fixed amount