Sign in

v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Coupons

This endpoint creates a specific coupon on a form. This feature is available as part of the Standard API.

post/forms/{slug_or_id}/coupons

Path parameters

slug_or_idstring required

The form's slug, custom slug or ID.

Request body

codestring

The coupon code.

enabledboolean

Whether the coupon is enabled or not.

target'price' | 'subscription'

The target of the coupon.

discountAmountnumber

The discount as an amount.

discountPercentagenumber

The discount as a percentage.

expiresAtstring date-time nullable

The date and time when the coupon expires.

Example request

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

Response

Successfully created a single coupon with the provided values

status'ok'

Example response

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