Appearance
@line/bot-sdk / messagingApi / CouponResponse
Type Alias: CouponResponse
CouponResponse =
object
Defined in: lib/messaging-api/model/couponResponse.ts:19
Detailed information about a coupon, including all properties and current status.
Properties
acquisitionCondition?
optionalacquisitionCondition:AcquisitionConditionResponse
Defined in: lib/messaging-api/model/couponResponse.ts:22
barcodeImageUrl?
optionalbarcodeImageUrl:string
Defined in: lib/messaging-api/model/couponResponse.ts:26
URL of the barcode image associated with the coupon. Used for in-store redemption.
couponCode?
optionalcouponCode:string
Defined in: lib/messaging-api/model/couponResponse.ts:30
Unique code to be presented by the user to redeem the coupon.
couponId?
optionalcouponId:string
Defined in: lib/messaging-api/model/couponResponse.ts:81
Unique identifier of the coupon.
createdTimestamp?
optionalcreatedTimestamp:number
Defined in: lib/messaging-api/model/couponResponse.ts:85
Created timestamp (seconds) of the coupon.
description?
optionaldescription:string
Defined in: lib/messaging-api/model/couponResponse.ts:34
Detailed description of the coupon. Displayed to users.
endTimestamp?
optionalendTimestamp:number
Defined in: lib/messaging-api/model/couponResponse.ts:38
Coupon expiration time (epoch seconds). Coupon cannot be used after this time.
imageUrl?
optionalimageUrl:string
Defined in: lib/messaging-api/model/couponResponse.ts:42
URL of the main image representing the coupon. Displayed in the coupon list.
maxAcquireCount?
optionalmaxAcquireCount:number
Defined in: lib/messaging-api/model/couponResponse.ts:46
Maximum number of coupons that can be issued in total.
maxTicketPerUser?
optionalmaxTicketPerUser:number
Defined in: lib/messaging-api/model/couponResponse.ts:54
Maximum number of coupon tickets a single user can acquire.
maxUseCountPerTicket?
optionalmaxUseCountPerTicket:number
Defined in: lib/messaging-api/model/couponResponse.ts:50
Maximum number of times a single coupon ticket can be used.
reward?
optionalreward:CouponRewardResponse
Defined in: lib/messaging-api/model/couponResponse.ts:69
startTimestamp?
optionalstartTimestamp:number
Defined in: lib/messaging-api/model/couponResponse.ts:58
Coupon start time (epoch seconds). Coupon can be used from this time.
status?
optionalstatus:StatusEnum
Defined in: lib/messaging-api/model/couponResponse.ts:89
Current status of the coupon.
timezone?
optionaltimezone:TimezoneEnum
Defined in: lib/messaging-api/model/couponResponse.ts:77
Timezone for interpreting start and end timestamps.
title?
optionaltitle:string
Defined in: lib/messaging-api/model/couponResponse.ts:62
Title of the coupon. Displayed in the coupon list.
usageCondition?
optionalusageCondition:string
Defined in: lib/messaging-api/model/couponResponse.ts:66
Conditions for using the coupon. Shown to users.
visibility?
optionalvisibility:VisibilityEnum
Defined in: lib/messaging-api/model/couponResponse.ts:73
Visibility of the coupon. Determines who can see or acquire the coupon.