Update coupon

Updates an existing coupon. The redemption code itself is immutable. Requires the COUPONS_WRITE scope.

Authorization

AuthorizationBearer <token>

Bearer token authentication. Pass the secret directly in the Authorization header. Token secrets start with sk_.

In: header

Path Parameters

storeId*string

Length12 <= length <= 48

couponId*string

Length12 <= length <= 48

Header Parameters

idempotency-key?string

Length8 <= length <= 32

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

code?string

Match^[A-Za-z0-9_\-]+$

Length2 <= length <= 64

displayName?|null

description?|null

type?|

value?integer

Range1 <= value

minimumPurchase?|null

maxUses?|null

maxUsesPerCustomer?|null

firstPurchaseOnly?boolean

startsAt?|null

expiresAt?|null

enabled?boolean

productIds?array<>|null

Response Body

`application/json`

curl -X PATCH "https://example.com/stores/stringstring/coupons/stringstring" \  -H "Content-Type: application/json" \  -d '{}'

{  "ok": true,  "data": {    "id": "cpn_p2v8q1mzj0kxw5h7n4tr3bcf",    "code": "LAUNCH20",    "displayName": "Launch week 20% off",    "description": "Limited-time launch discount.",    "type": "PERCENTAGE",    "value": 20,    "minimumPurchase": 1000,    "maxUses": 500,    "maxUsesPerCustomer": 1,    "firstPurchaseOnly": false,    "startsAt": "2026-05-01T00:00:00.000Z",    "expiresAt": "2026-06-01T00:00:00.000Z",    "enabled": true,    "timesUsed": 42,    "productIds": [],    "createdAt": "2026-04-28T08:30:00.000Z",    "updatedAt": "2026-05-12T11:15:00.000Z"  }}

Update coupon

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`