v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Coupons

This endpoint returns a coupon for a form that is accessible by the authorized user. This feature is available as part of the Standard API.

get/forms/{slug_or_id}/coupons/{code}

Path parameters

slug_or_idstring required

The form's slug, custom slug or ID.

codestring required

The coupon code to get results for.

Response

Successfully returned a coupon for a form

status'ok'

Example response

{
  "results": {
    "coupon": {
      "code": "DISCOUNT1",
      "enabled": true,
      "target": "price",
      "discountAmount": 10,
      "discountPercentage": 10,
      "expiresAt": "2020-01-01T00:00:00.000Z"
    }
  }
}