Promocode

Find a promocode by ID

Returns a single promocode of the coupon, with how many times it has been used.

Requires the bookings.read scope when using OAuth tokens.

get/coupons/{coupon_id}/promocodes/{id}.json

Request

Base URL
https://api.jammed.app/api/v2
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/jammed-org/apis/jammed-bookings-api/docs/coupons/:coupon_id/promocodes/:id.json/get.ts
A function with typed inputs. Its response is checked against the schema.

coupon_idinteger required

Coupon ID

idinteger required

Promocode ID

Authorizationstring required

successful operation

idinteger

codestring

The code the customer can use to redeem the promocode, they enter this code when booking.

The code is case-insensitive and must be unique

minimum_booking_valueinteger

The minimum booking value the Promocode can be used for.

If attempted for a booking below this value, the Coupon will not be applied

first_time_use_onlyboolean

If set to true, the Promocode will only be usable once per customer - applies to logged in customers only

redemption_limitinteger nullable

How many times the promocode can be used in total. null means there is no limit

number_of_times_usedinteger

How many times the promocode has been used. A redemption on a booking that was cancelled before it was confirmed no longer counts

fully_usedboolean

Is set as true once number_of_times_used has reached the redemption_limit