Add Coupon API Support to Messaging API (#1684)

line/line-openapi#111

# Add Coupon API Support to Messaging API
We've supported a set of new APIs that make it possible to create,
manage, and deliver coupons via the Messaging API. These features
provide functionality similar to what's available through the LINE
Official Account Manager interface ([see
here](https://www.lycbiz.com/jp/manual/OfficialAccountManager/coupons-create/)),
allowing developers to integrate coupon-related workflows into their
bots more flexibly.

For more details, see the official announcement:
[LINE Developers News — Coupon API Released
(2025/08/06)](https://developers.line.biz/en/news/2025/08/06/coupon-api/)

## New API Endpoints
- `POST /v2/bot/coupon`
Create a new coupon.
The request includes metadata such as the coupon title, description,
image URLs, validity period, reward details(e.g. 1000yen discount),
acquisition requirements, time zone, etc.

- `GET /v2/bot/coupon`
Retrieve a list of coupons associated with the bot.

- `GET /v2/bot/coupon/{couponId}`
Fetch detailed information about a specific coupon.

- `PUT /v2/bot/coupon/{couponId}`
Mark a coupon as expired.

## Messaging API Update
Message Object now supports a new type: `type=coupon`
This allows developers to send coupons directly to users via the
Messaging API, similar to sending text, image, or template messages.

## Example Requests
### Create a Coupon
```
POST /v2/bot/coupon
Content-Type: application/json
```
#### Request body
```json
{
  "title": "1000 yen off coupon",
  "acquisitionCondition": {
    "type": "normal"
  },
  "visibility": "PUBLIC",
  "startTimestamp": 1672537600,
  "endTimestamp": 1672624000,
  "maxUseCountPerTicket": 1,
  "reward": {
    "type": "discount",
    "priceInfo": {
      "priceInfoType": "fixed",
      "fixedAmount": 1000
    }
  },
  "imageUrl": "https://example.com/coupon_image.png",
  "barcodeImageUrl": "https://example.com/coupon_barcode.png",
  "timezone": "ASIA_TOKYO"
}
```
#### Response
```json
{
  "couponId": "abc1234"
}
```


### Send a Coupon Message

```json
{
  "to": "<userId>",
  "messages": [
    {
      "type": "coupon",
      "couponId": "abc1234"
    }
  ]
}
```

Co-authored-by: github-actions <[email protected]>

Author: github-actions[bot]

clients/line-bot-messaging-api-client/.openapi-generator/FILES

@@ -1,5 +1,7 @@
 src/main/java/com/linecorp/bot/messaging/client/MessagingApiBlobClient.java
 src/main/java/com/linecorp/bot/messaging/client/MessagingApiClient.java
+src/main/java/com/linecorp/bot/messaging/model/AcquisitionConditionRequest.java
+src/main/java/com/linecorp/bot/messaging/model/AcquisitionConditionResponse.java
 src/main/java/com/linecorp/bot/messaging/model/Action.java
 src/main/java/com/linecorp/bot/messaging/model/AgeDemographic.java
 src/main/java/com/linecorp/bot/messaging/model/AgeDemographicFilter.java
@@ -18,13 +20,44 @@ src/main/java/com/linecorp/bot/messaging/model/CameraAction.java
 src/main/java/com/linecorp/bot/messaging/model/CameraRollAction.java
 src/main/java/com/linecorp/bot/messaging/model/CarouselColumn.java
 src/main/java/com/linecorp/bot/messaging/model/CarouselTemplate.java
+src/main/java/com/linecorp/bot/messaging/model/CashBackFixedPriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CashBackFixedPriceInfoResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CashBackPercentagePriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CashBackPercentagePriceInfoResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CashBackPriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CashBackPriceInfoResponse.java
 src/main/java/com/linecorp/bot/messaging/model/ChatReference.java
 src/main/java/com/linecorp/bot/messaging/model/ClipboardAction.java
 src/main/java/com/linecorp/bot/messaging/model/ClipboardImagemapAction.java
 src/main/java/com/linecorp/bot/messaging/model/ConfirmTemplate.java
+src/main/java/com/linecorp/bot/messaging/model/CouponCashBackRewardRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CouponCashBackRewardResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CouponCreateRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CouponCreateResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CouponDiscountRewardRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CouponDiscountRewardResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CouponFreeRewardRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CouponFreeRewardResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CouponGiftRewardRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CouponGiftRewardResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CouponListResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CouponMessage.java
+src/main/java/com/linecorp/bot/messaging/model/CouponOthersRewardRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CouponOthersRewardResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CouponResponse.java
+src/main/java/com/linecorp/bot/messaging/model/CouponRewardRequest.java
+src/main/java/com/linecorp/bot/messaging/model/CouponRewardResponse.java
 src/main/java/com/linecorp/bot/messaging/model/CreateRichMenuAliasRequest.java
 src/main/java/com/linecorp/bot/messaging/model/DatetimePickerAction.java
 src/main/java/com/linecorp/bot/messaging/model/DemographicFilter.java
+src/main/java/com/linecorp/bot/messaging/model/DiscountExplicitPriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/DiscountExplicitPriceInfoResponse.java
+src/main/java/com/linecorp/bot/messaging/model/DiscountFixedPriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/DiscountFixedPriceInfoResponse.java
+src/main/java/com/linecorp/bot/messaging/model/DiscountPercentagePriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/DiscountPercentagePriceInfoResponse.java
+src/main/java/com/linecorp/bot/messaging/model/DiscountPriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/DiscountPriceInfoResponse.java
 src/main/java/com/linecorp/bot/messaging/model/Emoji.java
 src/main/java/com/linecorp/bot/messaging/model/EmojiSubstitutionObject.java
 src/main/java/com/linecorp/bot/messaging/model/ErrorDetail.java
@@ -83,6 +116,8 @@ src/main/java/com/linecorp/bot/messaging/model/IssueLinkTokenResponse.java
 src/main/java/com/linecorp/bot/messaging/model/Limit.java
 src/main/java/com/linecorp/bot/messaging/model/LocationAction.java
 src/main/java/com/linecorp/bot/messaging/model/LocationMessage.java
+src/main/java/com/linecorp/bot/messaging/model/LotteryAcquisitionConditionRequest.java
+src/main/java/com/linecorp/bot/messaging/model/LotteryAcquisitionConditionResponse.java
 src/main/java/com/linecorp/bot/messaging/model/MarkMessagesAsReadRequest.java
 src/main/java/com/linecorp/bot/messaging/model/MembersIdsResponse.java
 src/main/java/com/linecorp/bot/messaging/model/Membership.java
@@ -93,9 +128,12 @@ src/main/java/com/linecorp/bot/messaging/model/Message.java
 src/main/java/com/linecorp/bot/messaging/model/MessageAction.java
 src/main/java/com/linecorp/bot/messaging/model/MessageImagemapAction.java
 src/main/java/com/linecorp/bot/messaging/model/MessageQuotaResponse.java
+src/main/java/com/linecorp/bot/messaging/model/MessagingApiPagerCouponListResponse.java
 src/main/java/com/linecorp/bot/messaging/model/MulticastRequest.java
 src/main/java/com/linecorp/bot/messaging/model/NarrowcastProgressResponse.java
 src/main/java/com/linecorp/bot/messaging/model/NarrowcastRequest.java
+src/main/java/com/linecorp/bot/messaging/model/NormalAcquisitionConditionRequest.java
+src/main/java/com/linecorp/bot/messaging/model/NormalAcquisitionConditionResponse.java
 src/main/java/com/linecorp/bot/messaging/model/NumberOfMessagesResponse.java
 src/main/java/com/linecorp/bot/messaging/model/OperatorDemographicFilter.java
 src/main/java/com/linecorp/bot/messaging/model/OperatorRecipient.java
@@ -109,6 +147,7 @@ src/main/java/com/linecorp/bot/messaging/model/QuotaConsumptionResponse.java
 src/main/java/com/linecorp/bot/messaging/model/QuotaType.java
 src/main/java/com/linecorp/bot/messaging/model/Recipient.java
 src/main/java/com/linecorp/bot/messaging/model/RedeliveryRecipient.java
+src/main/java/com/linecorp/bot/messaging/model/ReferralAcquisitionConditionResponse.java
 src/main/java/com/linecorp/bot/messaging/model/ReplyMessageRequest.java
 src/main/java/com/linecorp/bot/messaging/model/ReplyMessageResponse.java
 src/main/java/com/linecorp/bot/messaging/model/RichMenuAliasListResponse.java
@@ -153,6 +192,14 @@ src/main/java/com/linecorp/bot/messaging/model/TextMessage.java
 src/main/java/com/linecorp/bot/messaging/model/TextMessageV2.java
 src/main/java/com/linecorp/bot/messaging/model/URIAction.java
 src/main/java/com/linecorp/bot/messaging/model/URIImagemapAction.java
+src/main/java/com/linecorp/bot/messaging/model/UnknownAcquisitionConditionRequest.java
+src/main/java/com/linecorp/bot/messaging/model/UnknownAcquisitionConditionResponse.java
+src/main/java/com/linecorp/bot/messaging/model/UnknownCashBackPriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/UnknownCashBackPriceInfoResponse.java
+src/main/java/com/linecorp/bot/messaging/model/UnknownCouponRewardRequest.java
+src/main/java/com/linecorp/bot/messaging/model/UnknownCouponRewardResponse.java
+src/main/java/com/linecorp/bot/messaging/model/UnknownDiscountPriceInfoRequest.java
+src/main/java/com/linecorp/bot/messaging/model/UnknownDiscountPriceInfoResponse.java
 src/main/java/com/linecorp/bot/messaging/model/UnknownMentionTarget.java
 src/main/java/com/linecorp/bot/messaging/model/UnknownSubstitutionObject.java
 src/main/java/com/linecorp/bot/messaging/model/UpdateRichMenuAliasRequest.java

clients/line-bot-messaging-api-client/src/main/java/com/linecorp/bot/messaging/client/MessagingApiClient.java

@@ -25,6 +25,9 @@
 import com.linecorp.bot.client.base.channel.ChannelTokenSupplier;
 import com.linecorp.bot.messaging.model.BotInfoResponse;
 import com.linecorp.bot.messaging.model.BroadcastRequest;
+import com.linecorp.bot.messaging.model.CouponCreateRequest;
+import com.linecorp.bot.messaging.model.CouponCreateResponse;
+import com.linecorp.bot.messaging.model.CouponResponse;
 import com.linecorp.bot.messaging.model.CreateRichMenuAliasRequest;
 import com.linecorp.bot.messaging.model.GetAggregationUnitNameListResponse;
 import com.linecorp.bot.messaging.model.GetAggregationUnitUsageResponse;
@@ -40,6 +43,7 @@
 import com.linecorp.bot.messaging.model.MembersIdsResponse;
 import com.linecorp.bot.messaging.model.MembershipListResponse;
 import com.linecorp.bot.messaging.model.MessageQuotaResponse;
+import com.linecorp.bot.messaging.model.MessagingApiPagerCouponListResponse;
 import com.linecorp.bot.messaging.model.MulticastRequest;
 import com.linecorp.bot.messaging.model.NarrowcastProgressResponse;
 import com.linecorp.bot.messaging.model.NarrowcastRequest;
@@ -70,6 +74,7 @@
 import com.linecorp.bot.messaging.model.UserProfileResponse;
 import com.linecorp.bot.messaging.model.ValidateMessageRequest;
 import java.net.URI;
+import java.util.Set;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 import retrofit2.http.*;
@@ -101,6 +106,27 @@ CompletableFuture<Result<Object>> broadcast(
   @DELETE("/v2/bot/user/all/richmenu")
   CompletableFuture<Result<Void>> cancelDefaultRichMenu();
 
+  /**
+   * Close coupon
+   *
+   * @param couponId (required)
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon">
+   *     Documentation</a>
+   */
+  @PUT("/v2/bot/coupon/{couponId}/close")
+  CompletableFuture<Result<Void>> closeCoupon(@Path("couponId") String couponId);
+
+  /**
+   * Create a new coupon. Define coupon details such as type, title, and validity period.
+   *
+   * @param couponCreateRequest (optional)
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-coupon">
+   *     Documentation</a>
+   */
+  @POST("/v2/bot/coupon")
+  CompletableFuture<Result<CouponCreateResponse>> createCoupon(
+      @Body CouponCreateRequest couponCreateRequest);
+
   /**
    * Create rich menu
    *
@@ -178,6 +204,16 @@ CompletableFuture<Result<GetAggregationUnitNameListResponse>> getAggregationUnit
   @GET("/v2/bot/info")
   CompletableFuture<Result<BotInfoResponse>> getBotInfo();
 
+  /**
+   * Get coupon detail
+   *
+   * @param couponId (required)
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupon">
+   *     Documentation</a>
+   */
+  @GET("/v2/bot/coupon/{couponId}")
+  CompletableFuture<Result<CouponResponse>> getCouponDetail(@Path("couponId") String couponId);
+
   /**
    * Gets the ID of the default rich menu set with the Messaging API.
    *
@@ -567,6 +603,21 @@ CompletableFuture<Result<Void>> linkRichMenuIdToUser(
   CompletableFuture<Result<Void>> linkRichMenuIdToUsers(
       @Body RichMenuBulkLinkRequest richMenuBulkLinkRequest);
 
+  /**
+   * Get a paginated list of coupons.
+   *
+   * @param status Filter coupons by their status. (optional)
+   * @param start Pagination token to retrieve the next page of results. (optional)
+   * @param limit Maximum number of coupons to return per request. (optional, default to 20)
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupons-list">
+   *     Documentation</a>
+   */
+  @GET("/v2/bot/coupon")
+  CompletableFuture<Result<MessagingApiPagerCouponListResponse>> listCoupon(
+      @Query("status") Set<String> status,
+      @Query("start") String start,
+      @Query("limit") Integer limit);
+
   /**
    * Mark messages from users as read
    *

clients/line-bot-messaging-api-client/src/main/java/com/linecorp/bot/messaging/model/AcquisitionConditionRequest.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech Do not edit the class manually.
+ */
+package com.linecorp.bot.messaging.model;
+
+
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+/** AcquisitionConditionRequest */
+@JsonSubTypes({
+  @JsonSubTypes.Type(value = LotteryAcquisitionConditionRequest.class, name = "lottery"),
+  @JsonSubTypes.Type(value = NormalAcquisitionConditionRequest.class, name = "normal"),
+})
+@JsonTypeInfo(
+    use = JsonTypeInfo.Id.NAME,
+    include = JsonTypeInfo.As.PROPERTY,
+    property = "type",
+    defaultImpl = UnknownAcquisitionConditionRequest.class,
+    visible = true)
+public interface AcquisitionConditionRequest {}

clients/line-bot-messaging-api-client/src/main/java/com/linecorp/bot/messaging/model/AcquisitionConditionResponse.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech Do not edit the class manually.
+ */
+package com.linecorp.bot.messaging.model;
+
+
+
+import com.fasterxml.jackson.annotation.JsonSubTypes;
+import com.fasterxml.jackson.annotation.JsonTypeInfo;
+
+/** AcquisitionConditionResponse */
+@JsonSubTypes({
+  @JsonSubTypes.Type(value = LotteryAcquisitionConditionResponse.class, name = "lottery"),
+  @JsonSubTypes.Type(value = NormalAcquisitionConditionResponse.class, name = "normal"),
+  @JsonSubTypes.Type(value = ReferralAcquisitionConditionResponse.class, name = "referral"),
+})
+@JsonTypeInfo(
+    use = JsonTypeInfo.Id.NAME,
+    include = JsonTypeInfo.As.PROPERTY,
+    property = "type",
+    defaultImpl = UnknownAcquisitionConditionResponse.class,
+    visible = true)
+public interface AcquisitionConditionResponse {}

clients/line-bot-messaging-api-client/src/main/java/com/linecorp/bot/messaging/model/CashBackFixedPriceInfoRequest.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech Do not edit the class manually.
+ */
+package com.linecorp.bot.messaging.model;
+
+
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+
+/** CashBackFixedPriceInfoRequest */
+@JsonTypeName("fixed")
+@JsonInclude(Include.NON_NULL)
+@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
+public record CashBackFixedPriceInfoRequest(
+    /** Get fixedAmount */
+    @JsonProperty("fixedAmount") Long fixedAmount) implements CashBackPriceInfoRequest {
+
+  public static class Builder {
+    private Long fixedAmount;
+
+    public Builder() {}
+
+    public Builder fixedAmount(Long fixedAmount) {
+      this.fixedAmount = fixedAmount;
+      return this;
+    }
+
+    public CashBackFixedPriceInfoRequest build() {
+      return new CashBackFixedPriceInfoRequest(fixedAmount);
+    }
+  }
+}

clients/line-bot-messaging-api-client/src/main/java/com/linecorp/bot/messaging/model/CashBackFixedPriceInfoResponse.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2023 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech Do not edit the class manually.
+ */
+package com.linecorp.bot.messaging.model;
+
+
+
+import com.fasterxml.jackson.annotation.JsonEnumDefaultValue;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonInclude.Include;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+
+/** CashBackFixedPriceInfoResponse */
+@JsonTypeName("fixed")
+@JsonInclude(Include.NON_NULL)
+@javax.annotation.Generated(value = "com.linecorp.bot.codegen.LineJavaCodegenGenerator")
+public record CashBackFixedPriceInfoResponse(
+    /** Currency code (e.g., JPY, THB, TWD). */
+    @JsonProperty("currency") Currency currency,
+    /** Get fixedAmount */
+    @JsonProperty("fixedAmount") Long fixedAmount)
+    implements CashBackPriceInfoResponse {
+  /** Currency code (e.g., JPY, THB, TWD). */
+  public enum Currency {
+    @JsonProperty("JPY")
+    JPY,
+    @JsonProperty("THB")
+    THB,
+    @JsonProperty("TWD")
+    TWD,
+
+    @JsonEnumDefaultValue
+    UNDEFINED;
+  }
+
+  public static class Builder {
+    private Currency currency;
+    private Long fixedAmount;
+
+    public Builder() {}
+
+    public Builder currency(Currency currency) {
+      this.currency = currency;
+      return this;
+    }
+
+    public Builder fixedAmount(Long fixedAmount) {
+      this.fixedAmount = fixedAmount;
+      return this;
+    }
+
+    public CashBackFixedPriceInfoResponse build() {
+      return new CashBackFixedPriceInfoResponse(currency, fixedAmount);
+    }
+  }
+}