BillKit/DocsConsole
Coupons

Update coupon

Update a coupon's limits, or withdraw it.

POST/v1/coupons/{coupon_id}
Operation update_coupon·Scope coupons:write·OpenAPI v1.1.0

Parameters

ParameterDescription
coupon_idstring · pathrequiredId of the coupon, which starts coup_.
activebooleanoptionalfalse withdraws the code so it can no longer be redeemed; true makes it available again.
applies_to_price_idsarray of string | nulloptionalIds of the prices the coupon can be used with. null or empty allows any price.
max_redemptionsinteger | nulloptionalMaximum number of times the coupon can be redeemed. null removes the limit. Between 1 and 2147483647.
min_amount_centsinteger | nulloptionalMinimum charge, before the discount, in minor units of currency. Refused on a coupon with no currency. null removes the minimum. Between 0 and 99999999.
redeem_byinteger | nulloptionalLast time the coupon can be redeemed, in Unix seconds. null removes the deadline. Between 0 and 253402300799.

Returns

Returns a CouponResponse object.

Errors

StatusCause
400The request was refused (type: invalid_request_error): a required parameter is missing (parameter_missing), one failed validation (parameter_invalid) or is not one the operation takes (parameter_unknown), and param names it.
401No credential, or one that does not authenticate.
402The account is suspended (tenant_suspended), or the payment provider refused a charge or refund the call made (type: payment_error, code: payment_refused).
403Authenticated, but not allowed: missing scope (insufficient_scope), a key of the wrong mode (mode_mismatch), or a refused origin. Needs the coupons:write scope.
404No such object in this account and mode.
409Conflicts with the object's current state (state_conflict, or a more specific code), or an operation still in flight (operation_pending).
413The request body is larger than the API accepts.
429Rate limited. Retry-After says when to try again.
500Something failed on BillKit's side (type: api_error). Retry with the same Idempotency-Key.
502The payment provider failed or did not answer.
503Temporarily unable to serve. reason says whether the request was attempted.
Request · curl
curl -X POST https://api.billkit.eu/v1/coupons/coup_9XKp2vQ1 \
  -H "Authorization: Bearer $BILLKIT_API_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,
  "amount_off_cents": 1900,
  "applies_to_price_ids": [
    "string"
  ],
  "code": "string",
  "created": 1789392000,
  "currency": "EUR",
  "discount_type": "percent",
  "duration": "once",
  "duration_in_months": 0,
  "id": "coup_9XKp2vQ1",
  "livemode": false,
  "max_redemptions": 0,
  "min_amount_cents": 1900,
  "object": "coupon",
  "percent_off": 0,
  "redeem_by": 0,
  "redemptions_count": 0
}