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:20
barcodeImageUrl?
optionalbarcodeImageUrl?:string
Defined in: lib/messaging-api/model/couponResponse.ts:24
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:28
Unique code to be presented by the user to redeem the coupon.
couponId?
optionalcouponId?:string
Defined in: lib/messaging-api/model/couponResponse.ts:77
Unique identifier of the coupon.
createdTimestamp?
optionalcreatedTimestamp?:number
Defined in: lib/messaging-api/model/couponResponse.ts:81
Created timestamp (seconds) of the coupon.
description?
optionaldescription?:string
Defined in: lib/messaging-api/model/couponResponse.ts:32
Detailed description of the coupon. Displayed to users.
endTimestamp?
optionalendTimestamp?:number
Defined in: lib/messaging-api/model/couponResponse.ts:36
Coupon expiration time (epoch seconds). Coupon cannot be used after this time.
imageUrl?
optionalimageUrl?:string
Defined in: lib/messaging-api/model/couponResponse.ts:40
URL of the main image representing the coupon. Displayed in the coupon list.
maxAcquireCount?
optionalmaxAcquireCount?:number
Defined in: lib/messaging-api/model/couponResponse.ts:44
Maximum number of coupons that can be issued in total.
maxTicketPerUser?
optionalmaxTicketPerUser?:number
Defined in: lib/messaging-api/model/couponResponse.ts:52
Maximum number of coupon tickets a single user can acquire.
maxUseCountPerTicket?
optionalmaxUseCountPerTicket?:number
Defined in: lib/messaging-api/model/couponResponse.ts:48
Maximum number of times a single coupon ticket can be used.
reward?
optionalreward?:CouponRewardResponse
Defined in: lib/messaging-api/model/couponResponse.ts:65
startTimestamp?
optionalstartTimestamp?:number
Defined in: lib/messaging-api/model/couponResponse.ts:56
Coupon start time (epoch seconds). Coupon can be used from this time.
status?
optionalstatus?:StatusEnum
Defined in: lib/messaging-api/model/couponResponse.ts:85
Current status of the coupon.
timezone?
optionaltimezone?:TimezoneEnum
Defined in: lib/messaging-api/model/couponResponse.ts:73
Timezone for interpreting start and end timestamps.
title?
optionaltitle?:string
Defined in: lib/messaging-api/model/couponResponse.ts:60
Title of the coupon. Displayed in the coupon list.
usageCondition?
optionalusageCondition?:string
Defined in: lib/messaging-api/model/couponResponse.ts:64
Conditions for using the coupon. Shown to users.
visibility?
optionalvisibility?:VisibilityEnum
Defined in: lib/messaging-api/model/couponResponse.ts:69
Visibility of the coupon. Determines who can see or acquire the coupon.