Appearance
@line/bot-sdk / messagingApi / CouponCreateRequest
Type Alias: CouponCreateRequest
CouponCreateRequest =
object
Defined in: lib/messaging-api/model/couponCreateRequest.ts:19
Request object for creating a coupon. Contains all configurable coupon properties.
Properties
acquisitionCondition
acquisitionCondition:
AcquisitionConditionRequest
Defined in: lib/messaging-api/model/couponCreateRequest.ts:22
barcodeImageUrl?
optional
barcodeImageUrl:string
Defined in: lib/messaging-api/model/couponCreateRequest.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/couponCreateRequest.ts:30
Unique code to be presented by the user to redeem the coupon. Optional.
description?
optional
description:string
Defined in: lib/messaging-api/model/couponCreateRequest.ts:34
Detailed description of the coupon. Displayed to users.
endTimestamp
endTimestamp:
number
Defined in: lib/messaging-api/model/couponCreateRequest.ts:38
Coupon expiration time (epoch seconds). Coupon cannot be used after this time.
imageUrl?
optional
imageUrl:string
Defined in: lib/messaging-api/model/couponCreateRequest.ts:42
URL of the main image representing the coupon. Displayed in the coupon list.
maxUseCountPerTicket
maxUseCountPerTicket:
number
Defined in: lib/messaging-api/model/couponCreateRequest.ts:46
Maximum number of times a single coupon ticket can be used. Use -1 to indicate no limit.
reward?
optional
reward:CouponRewardRequest
Defined in: lib/messaging-api/model/couponCreateRequest.ts:61
startTimestamp
startTimestamp:
number
Defined in: lib/messaging-api/model/couponCreateRequest.ts:50
Coupon start time (epoch seconds). Coupon can be used from this time.
timezone
timezone:
TimezoneEnum
Defined in: lib/messaging-api/model/couponCreateRequest.ts:69
Timezone for interpreting start and end timestamps.
title
title:
string
Defined in: lib/messaging-api/model/couponCreateRequest.ts:54
Title of the coupon. Displayed in the coupon list.
usageCondition?
optional
usageCondition:string
Defined in: lib/messaging-api/model/couponCreateRequest.ts:58
Conditions for using the coupon. Shown to users.
visibility
visibility:
VisibilityEnum
Defined in: lib/messaging-api/model/couponCreateRequest.ts:65
Visibility of the coupon. Determines who can see or acquire the coupon.