Update a coupon
Partial update: only the fields sent change.
Path Parameters
- Type: stringFormat: uuididrequired
Coupon id.
Body·
required
application/json
Any subset of writable fields. At least one is required. Unknown or read-only fields are rejected.
- Type: number | nullamount
_off A fixed amount in minor units. Exactly one of percent_off and amount_off.
- Type: object | nullapplies
_to Properties: 1Optional restriction for line discounts: {"product_ids": [...]} or {"categories": ["entertainment"]}. Empty: any line.
- Type: string | nulllabel
What the contract prints: "Preferred planner".
- Type: string | nullenumlevel
Where it may be applied: to one line, to the gig’s discountable subtotal, or either.
valueslinegigeithernull - Type: number | nullorder
- Type: number | nullpercent
_off 0 to 100. Exactly one of percent_off and amount_off.
- Type: "active" or "inactive" or nullenumstatus
Active coupons can be applied; inactive are retired.
Responses
- application/json
- application/json
- application/json
- application/json
- application/json
- application/json
Request Example for patch/coupons/{id}
curl https://api.weddingoperatingsystems.com/api/v1/coupons/123e4567-e89b-12d3-a456-426614174000 \
--request PATCH \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"label": null,
"status": "active",
"percent_off": null,
"amount_off": null,
"level": "line",
"applies_to": null,
"order": null
}'
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"label": null,
"status": "active",
"percent_off": null,
"amount_off": null,
"level": "line",
"applies_to": null,
"order": null,
"created_time": "2026-10-08T19:05:34.884Z",
"last_edited_time": "2026-10-08T19:05:34.884Z"
}
}