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?
optional
acquisitionCondition:AcquisitionConditionResponse
Defined in: lib/messaging-api/model/couponResponse.ts:22
barcodeImageUrl?
optional
barcodeImageUrl: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?
optional
couponCode:string
Defined in: lib/messaging-api/model/couponResponse.ts:30
Unique code to be presented by the user to redeem the coupon.
couponId?
optional
couponId:string
Defined in: lib/messaging-api/model/couponResponse.ts:81
Unique identifier of the coupon.
createdTimestamp?
optional
createdTimestamp:number
Defined in: lib/messaging-api/model/couponResponse.ts:85
Created timestamp (seconds) of the coupon.
description?
optional
description:string
Defined in: lib/messaging-api/model/couponResponse.ts:34
Detailed description of the coupon. Displayed to users.
endTimestamp?
optional
endTimestamp:number
Defined in: lib/messaging-api/model/couponResponse.ts:38
Coupon expiration time (epoch seconds). Coupon cannot be used after this time.
imageUrl?
optional
imageUrl:string
Defined in: lib/messaging-api/model/couponResponse.ts:42
URL of the main image representing the coupon. Displayed in the coupon list.
maxAcquireCount?
optional
maxAcquireCount:number
Defined in: lib/messaging-api/model/couponResponse.ts:46
Maximum number of coupons that can be issued in total.
maxTicketPerUser?
optional
maxTicketPerUser:number
Defined in: lib/messaging-api/model/couponResponse.ts:54
Maximum number of coupon tickets a single user can acquire.
maxUseCountPerTicket?
optional
maxUseCountPerTicket:number
Defined in: lib/messaging-api/model/couponResponse.ts:50
Maximum number of times a single coupon ticket can be used.
reward?
optional
reward:CouponRewardResponse
Defined in: lib/messaging-api/model/couponResponse.ts:69
startTimestamp?
optional
startTimestamp:number
Defined in: lib/messaging-api/model/couponResponse.ts:58
Coupon start time (epoch seconds). Coupon can be used from this time.
status?
optional
status:StatusEnum
Defined in: lib/messaging-api/model/couponResponse.ts:89
Current status of the coupon.
timezone?
optional
timezone:TimezoneEnum
Defined in: lib/messaging-api/model/couponResponse.ts:77
Timezone for interpreting start and end timestamps.
title?
optional
title:string
Defined in: lib/messaging-api/model/couponResponse.ts:62
Title of the coupon. Displayed in the coupon list.
usageCondition?
optional
usageCondition:string
Defined in: lib/messaging-api/model/couponResponse.ts:66
Conditions for using the coupon. Shown to users.
visibility?
optional
visibility:VisibilityEnum
Defined in: lib/messaging-api/model/couponResponse.ts:73
Visibility of the coupon. Determines who can see or acquire the coupon.