Coupons

Update a coupon

patch/api/v1/coupons/{coupon_id}

Path parameters

coupon_idstring MeteroidId required
Example:cou_7n42DGM5Tflk9n8mt7Fhc7

Coupon ID

Request body

descriptionstring nullable
plan_idsPlanId[] nullable

Example request

{
  "plan_ids": [
    "plan_7n42DGM5Tflk9n8mt7Fhc7"
  ]
}

Response

Coupon updated

archived_atstring date-time nullable
codestring required
created_atstring date-time required
descriptionstring nullable
disabledboolean required
expires_atstring date-time nullable
idstring MeteroidId required
plan_idsPlanId[] required
recurring_valueinteger nullable
redemption_countinteger required
redemption_limitinteger nullable
reusableboolean required

Example response

{
  "id": "cou_7n42DGM5Tflk9n8mt7Fhc7",
  "plan_ids": [
    "plan_7n42DGM5Tflk9n8mt7Fhc7"
  ]
}

Changes