Update a coupon

Updates an existing coupon’s properties such as name, description, and metadata.

PATCH /api/v1/coupons/{id}

JavaScript

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.updateCoupon('x');

console.log(coupon.data);

200

{
  "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).

Path Parameters

id · string · required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Partially update an existing coupon. Only provided fields are updated.

name · string

Name of the coupon

Maximum string length: 40

description · string | null

Description of the coupon

Maximum string length: 255

metadata · object

Metadata associated with the entity

Show child attributes

Response

200

application/json

The updated coupon object.

Response object

data · Coupon · object · required

Discount instrument with percentage or fixed amount

Show child attributes