Coupon Endpoints

Create a coupon

Create a new coupon on Jammed.

With a new coupon, you must at least provide an name, amount and discount_type.

discount type is either fixed_amount, or percentage - and amount is in pence/cents or whole pencentage points.

Once created, a Coupon can be used by staff members only on a booking. To allow customers to use the Coupon, you need to generate Promocode for the Coupon.

post/coupons.json

Headers

Authorizationstring required

Response

Coupon created

idinteger

namestring

A label for the coupon - this is seen by your customers

discount_typestring

The type of discount the coupon gives

Either: 'fixed_amount' or 'percentage'

amountinteger

The integer decimal amount, or percentage that the coupon will deduct.

For discount_type=percentage, 10 would mean 10%

For discount_type=fixed_amount, 10 would mean $0.10 or £0.10 etc

all_new_customersboolean

Set to true if you want the coupon to apply to all new customers automatically

expires_atstring

The ISO8601 timestamp when the coupon expires. If not set, the coupon will never expire

created_atstring

The ISO8601 timestamp when the coupon was created

fully_usedboolean

Is set as true if the coupon has been used up, and cannot be used anymore

expiredboolean

Is set as true if the coupon has expired

statusstring

The status of the coupon: active, deleted, expired, fully used

durationstring

The duration of the coupon: once, forever

If forever, the coupon can be used over and over by the same customer

If once, the coupon can only be used once by the same customer

total_number_of_usesinteger

The total number of times the coupon can be used

number_of_times_usedinteger

The number of times the coupon has been used

Changes

Changed in 4 of the 32 revisions of this API.320

May 6, 2022v2c0668e260bdb214See the full diff
- ▲
  the request property / became required
  request-property-became-required
- ▲
  the response's body type changed from array to object for status
  response-body-type-changed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
May 6, 2022v2e09b5fb757b25See the full diff
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the new optional request property /
  new-optional-request-property
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
May 5, 2022v238fea9f464391See the full diff
- ○
  endpoint added
  endpoint-added
May 5, 2022v295c52cb13f9a1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 29 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history