HIhitpayapp

Get Coupon Details

Changed on

Get a coupon, including the categories or products it applies to.

get/v1/coupons/{coupon_id}

Request

  • Base URL
    https://api.hit-pay.com
  • URL
    https://api.hit-pay.com/v1/coupons/{coupon_id}
  • Auth
    none declared. Required headers: X-BUSINESS-API-KEY

Path parameters

coupon_idstring uuid required

The coupon ID.

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

idstring uuid
business_idstring uuid
namestring
codestring
fixed_amountinteger

Fixed discount in minor units (cents).

percentagenumber

Percentage discount as a fraction (0.15 = 15%).

coupons_leftinteger nullable

Remaining uses; null = unlimited.

is_promo_bannerboolean
banner_textstring nullable
created_atstring date-time
updated_atstring date-time
starts_atstring date-time nullable

UTC.

ends_atstring date-time nullable

UTC.

coupon_type1 | 2 | 3
minimum_cart_amountinteger

Minimum cart amount in minor units (cents).

deleted_atstring date-time nullable

Changes