JAjammed-org
Coupon

Find a coupon by ID

Changed on

Returns coupon with the given ID

get/coupons/{id}.json

Request

  • Base URL
    https://api.jammed.app/api/v2
  • Auth
    none declared. Required headers: Authorization

Path parameters

idinteger required

Headers

Authorizationstring required

Response

successful operation

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