Create Coupon

Create a coupon in the current company. App connections need the booking:write or inventory:write scope.

POST

/api/v1/coupon

POST

/coupon

curl -X POST "https://dash.lockii.app/api/v1/coupon" \
  -H "x-api-key: $LOCKII_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string",
  "name": "string"
}'

Authorization

x-api-key
string
header
API key from Settings → Integrations → API.
Authorization
string
header
The same API key, or an OAuth access token, sent as Authorization: Bearer.
api_key
string
query
API key query parameter.

Body

application/json

id
string
required
Coupon ID, usually coupon_<uuid>
name
string
required
Coupon name/code
uses
integer
Maximum uses, or -1 for unlimited uses
Default:
-1
used
integer
Times used
Default:
0
staticDiscount
number
Fixed discount in cents
Default:
0
percentageDiscount
number
Percentage discount points
Default:
0
companyID
string
Company ID. Defaults to the authenticated user's company.
archived
boolean
Default:
false

Response

application/json

JSON result for this operation.

object

{}