Coupons

Update a coupon

Changed on
patch/api/v1/coupons/{coupon_id}

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

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

  • v14e013b4e4a8fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • v1ee465c53a423Revision changes
    • breaking

      removed from the request property oneOf list

    • breaking

      the ///// response's property format changed from decimal to no format for status

    • breaking

      the ///// response's property format changed from decimal to no format for status

    • info

      added to the request property oneOf list

    • info

      response discriminator property name changed for response property from discriminator to type for the response status