BillKit/Docs Console
Coupons

Update coupon

Update a coupon's limits, or withdraw it.

POST/v1/coupons/{coupon_id}
Operation update_coupon · Scope coupons:write · Spec snapshot 2026-09-13

Parameters

ParameterDescription
coupon_idstring · pathrequiredNo description in the spec.
activeboolean | nulloptionalNo description in the spec.
applies_to_price_idsarray of string | nulloptionalNo description in the spec.
max_redemptionsinteger | nulloptionalMinimum 1.
min_amount_centsinteger | nulloptionalMinimum 0.
redeem_byinteger | nulloptionalMinimum 0.

Returns

Returns a CouponResponse object.

Errors

Status Cause
401 Missing or invalid API key.
403 Key is missing the coupons:write scope.
404 No such object, or it belongs to the other mode.
422 Validation Error
429 Rate limited. Back off and retry.
Request · curl 
curl -X POST https://api.billkit.eu/v1/coupons/coup_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
Request body · every field 
{
  "active": false,
  "applies_to_price_ids": [
    "string"
  ],
  "max_redemptions": 0,
  "min_amount_cents": 1900,
  "redeem_by": 0
}
Response · 200 OK 
{
  "active": false,
  "applies_to_price_ids": [
    "string"
  ],
  "code": "string",
  "created": 1789392000,
  "discount_type": "string",
  "discount_value": 0,
  "duration": "string",
  "duration_in_months": 0,
  "id": "coup_9XKp2vQ1",
  "livemode": false,
  "max_redemptions": 0,
  "min_amount_cents": 1900,
  "object": "coupon",
  "redeem_by": 0,
  "redemptions_count": 0
}