Coupons

Get Coupon

Retrieve detailed information about a specific coupon including redemption history.

get/api/v2/coupons/{coupon_id}

Path parameters

coupon_idstring uuid required

Unique identifier (UUID) of the coupon

Successful Response

created_atstring date-time

Creation timestamp of the object.

updated_atstring date-time nullable

Last modification timestamp of the object.

idstring uuid4

Unique identifier (UUID) of the coupon

namestring

Name of the coupon.

discount_valuestring

Discount value of the coupon (either percentage or fixed).

currency'SAR' | 'USD' | 'EUR' | 'GBP' | 'AED' | 'BHD' | 'KWD' | 'OMR' | 'QAR'

ISO 4217 currency codes supported by Moyasar.

Includes all currencies supported by Moyasar payment gateway.

is_percentageboolean

True if the discount is a percentage, False if it is a fixed amount.

is_activeboolean

Indicates if the coupon is currently active.

redemptionsinteger

Indicates how many times this coupon has been used.

No recorded changes to this endpoint across all 1 revision of this API.