v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Coupons

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

get/forms/{slug_or_id}/coupons

Path parameters

slug_or_idstring required

The form's slug, custom slug or ID.

Response

Successfully returned a list of coupons for a form

status'ok'

Example response

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