Add Coupon API Support to Messaging API (#1361)

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]

lib/messaging-api/.openapi-generator/FILES

@@ -3,6 +3,8 @@ api.ts
 api/apis.ts
 api/messagingApiBlobClient.ts
 api/messagingApiClient.ts
+model/acquisitionConditionRequest.ts
+model/acquisitionConditionResponse.ts
 model/action.ts
 model/ageDemographic.ts
 model/ageDemographicFilter.ts
@@ -21,13 +23,44 @@ model/cameraAction.ts
 model/cameraRollAction.ts
 model/carouselColumn.ts
 model/carouselTemplate.ts
+model/cashBackFixedPriceInfoRequest.ts
+model/cashBackFixedPriceInfoResponse.ts
+model/cashBackPercentagePriceInfoRequest.ts
+model/cashBackPercentagePriceInfoResponse.ts
+model/cashBackPriceInfoRequest.ts
+model/cashBackPriceInfoResponse.ts
 model/chatReference.ts
 model/clipboardAction.ts
 model/clipboardImagemapAction.ts
 model/confirmTemplate.ts
+model/couponCashBackRewardRequest.ts
+model/couponCashBackRewardResponse.ts
+model/couponCreateRequest.ts
+model/couponCreateResponse.ts
+model/couponDiscountRewardRequest.ts
+model/couponDiscountRewardResponse.ts
+model/couponFreeRewardRequest.ts
+model/couponFreeRewardResponse.ts
+model/couponGiftRewardRequest.ts
+model/couponGiftRewardResponse.ts
+model/couponListResponse.ts
+model/couponMessage.ts
+model/couponOthersRewardRequest.ts
+model/couponOthersRewardResponse.ts
+model/couponResponse.ts
+model/couponRewardRequest.ts
+model/couponRewardResponse.ts
 model/createRichMenuAliasRequest.ts
 model/datetimePickerAction.ts
 model/demographicFilter.ts
+model/discountExplicitPriceInfoRequest.ts
+model/discountExplicitPriceInfoResponse.ts
+model/discountFixedPriceInfoRequest.ts
+model/discountFixedPriceInfoResponse.ts
+model/discountPercentagePriceInfoRequest.ts
+model/discountPercentagePriceInfoResponse.ts
+model/discountPriceInfoRequest.ts
+model/discountPriceInfoResponse.ts
 model/emoji.ts
 model/emojiSubstitutionObject.ts
 model/errorDetail.ts
@@ -86,6 +119,8 @@ model/issueLinkTokenResponse.ts
 model/limit.ts
 model/locationAction.ts
 model/locationMessage.ts
+model/lotteryAcquisitionConditionRequest.ts
+model/lotteryAcquisitionConditionResponse.ts
 model/markMessagesAsReadRequest.ts
 model/membersIdsResponse.ts
 model/membership.ts
@@ -96,10 +131,13 @@ model/message.ts
 model/messageAction.ts
 model/messageImagemapAction.ts
 model/messageQuotaResponse.ts
+model/messagingApiPagerCouponListResponse.ts
 model/models.ts
 model/multicastRequest.ts
 model/narrowcastProgressResponse.ts
 model/narrowcastRequest.ts
+model/normalAcquisitionConditionRequest.ts
+model/normalAcquisitionConditionResponse.ts
 model/numberOfMessagesResponse.ts
 model/operatorDemographicFilter.ts
 model/operatorRecipient.ts
@@ -113,6 +151,7 @@ model/quotaConsumptionResponse.ts
 model/quotaType.ts
 model/recipient.ts
 model/redeliveryRecipient.ts
+model/referralAcquisitionConditionResponse.ts
 model/replyMessageRequest.ts
 model/replyMessageResponse.ts
 model/richMenuAliasListResponse.ts

lib/messaging-api/api/messagingApiClient.ts

@@ -13,6 +13,9 @@
 /* tslint:disable:no-unused-locals */
 import { BotInfoResponse } from "../model/botInfoResponse.js";
 import { BroadcastRequest } from "../model/broadcastRequest.js";
+import { CouponCreateRequest } from "../model/couponCreateRequest.js";
+import { CouponCreateResponse } from "../model/couponCreateResponse.js";
+import { CouponResponse } from "../model/couponResponse.js";
 import { CreateRichMenuAliasRequest } from "../model/createRichMenuAliasRequest.js";
 import { ErrorResponse } from "../model/errorResponse.js";
 import { GetAggregationUnitNameListResponse } from "../model/getAggregationUnitNameListResponse.js";
@@ -29,6 +32,7 @@ import { MarkMessagesAsReadRequest } from "../model/markMessagesAsReadRequest.js
 import { MembersIdsResponse } from "../model/membersIdsResponse.js";
 import { MembershipListResponse } from "../model/membershipListResponse.js";
 import { MessageQuotaResponse } from "../model/messageQuotaResponse.js";
+import { MessagingApiPagerCouponListResponse } from "../model/messagingApiPagerCouponListResponse.js";
 import { MulticastRequest } from "../model/multicastRequest.js";
 import { NarrowcastProgressResponse } from "../model/narrowcastProgressResponse.js";
 import { NarrowcastRequest } from "../model/narrowcastRequest.js";
@@ -158,6 +162,64 @@ export class MessagingApiClient {
     const parsedBody = text ? JSON.parse(text) : null;
     return { httpResponse: res, body: parsedBody };
   }
+  /**
+   * Close coupon
+   * @param couponId
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon"> Documentation</a>
+   */
+  public async closeCoupon(
+    couponId: string,
+  ): Promise<Types.MessageAPIResponseBase> {
+    return (await this.closeCouponWithHttpInfo(couponId)).body;
+  }
+
+  /**
+   * Close coupon.
+   * This method includes HttpInfo object to return additional information.
+   * @param couponId
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon"> Documentation</a>
+   */
+  public async closeCouponWithHttpInfo(
+    couponId: string,
+  ): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>> {
+    const res = await this.httpClient.put(
+      "/v2/bot/coupon/{couponId}/close".replace("{couponId}", String(couponId)),
+    );
+    const text = await res.text();
+    const parsedBody = text ? JSON.parse(text) : null;
+    return { httpResponse: res, body: parsedBody };
+  }
+  /**
+   * Create a new coupon. Define coupon details such as type, title, and validity period.
+   * @param couponCreateRequest
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-coupon"> Documentation</a>
+   */
+  public async createCoupon(
+    couponCreateRequest?: CouponCreateRequest,
+  ): Promise<CouponCreateResponse> {
+    return (await this.createCouponWithHttpInfo(couponCreateRequest)).body;
+  }
+
+  /**
+   * Create a new coupon. Define coupon details such as type, title, and validity period..
+   * This method includes HttpInfo object to return additional information.
+   * @param couponCreateRequest
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-coupon"> Documentation</a>
+   */
+  public async createCouponWithHttpInfo(
+    couponCreateRequest?: CouponCreateRequest,
+  ): Promise<Types.ApiResponseType<CouponCreateResponse>> {
+    const params = couponCreateRequest;
+
+    const res = await this.httpClient.post("/v2/bot/coupon", params);
+    const text = await res.text();
+    const parsedBody = text ? JSON.parse(text) : null;
+    return { httpResponse: res, body: parsedBody };
+  }
   /**
    * Create rich menu
    * @param richMenuRequest
@@ -373,6 +435,33 @@ export class MessagingApiClient {
     const parsedBody = text ? JSON.parse(text) : null;
     return { httpResponse: res, body: parsedBody };
   }
+  /**
+   * Get coupon detail
+   * @param couponId
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupon"> Documentation</a>
+   */
+  public async getCouponDetail(couponId: string): Promise<CouponResponse> {
+    return (await this.getCouponDetailWithHttpInfo(couponId)).body;
+  }
+
+  /**
+   * Get coupon detail.
+   * This method includes HttpInfo object to return additional information.
+   * @param couponId
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupon"> Documentation</a>
+   */
+  public async getCouponDetailWithHttpInfo(
+    couponId: string,
+  ): Promise<Types.ApiResponseType<CouponResponse>> {
+    const res = await this.httpClient.get(
+      "/v2/bot/coupon/{couponId}".replace("{couponId}", String(couponId)),
+    );
+    const text = await res.text();
+    const parsedBody = text ? JSON.parse(text) : null;
+    return { httpResponse: res, body: parsedBody };
+  }
   /**
    * Gets the ID of the default rich menu set with the Messaging API.
    *
@@ -1463,6 +1552,52 @@ export class MessagingApiClient {
     const parsedBody = text ? JSON.parse(text) : null;
     return { httpResponse: res, body: parsedBody };
   }
+  /**
+   * Get a paginated list of coupons.
+   * @param status Filter coupons by their status.
+   * @param start Pagination token to retrieve the next page of results.
+   * @param limit Maximum number of coupons to return per request.
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupons-list"> Documentation</a>
+   */
+  public async listCoupon(
+    status?: Set<"DRAFT" | "RUNNING" | "CLOSED">,
+    start?: string,
+    limit?: number,
+  ): Promise<MessagingApiPagerCouponListResponse> {
+    return (await this.listCouponWithHttpInfo(status, start, limit)).body;
+  }
+
+  /**
+   * Get a paginated list of coupons..
+   * This method includes HttpInfo object to return additional information.
+   * @param status Filter coupons by their status.
+   * @param start Pagination token to retrieve the next page of results.
+   * @param limit Maximum number of coupons to return per request.
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupons-list"> Documentation</a>
+   */
+  public async listCouponWithHttpInfo(
+    status?: Set<"DRAFT" | "RUNNING" | "CLOSED">,
+    start?: string,
+    limit?: number,
+  ): Promise<Types.ApiResponseType<MessagingApiPagerCouponListResponse>> {
+    const queryParams = {
+      status: status,
+      start: start,
+      limit: limit,
+    };
+    Object.keys(queryParams).forEach((key: keyof typeof queryParams) => {
+      if (queryParams[key] === undefined) {
+        delete queryParams[key];
+      }
+    });
+
+    const res = await this.httpClient.get("/v2/bot/coupon", queryParams);
+    const text = await res.text();
+    const parsedBody = text ? JSON.parse(text) : null;
+    return { httpResponse: res, body: parsedBody };
+  }
   /**
    * Mark messages from users as read
    * @param markMessagesAsReadRequest

lib/messaging-api/model/acquisitionConditionRequest.ts

@@ -0,0 +1,25 @@
+/**
+ * LINE Messaging API
+ * This document describes LINE Messaging API.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { LotteryAcquisitionConditionRequest } from "./models.js";
+import { NormalAcquisitionConditionRequest } from "./models.js";
+
+export type AcquisitionConditionRequest =
+  | LotteryAcquisitionConditionRequest // lottery
+  | NormalAcquisitionConditionRequest; // normal
+
+export type AcquisitionConditionRequestBase = {
+  /**
+   * Determines how the coupon is distributed or used.
+   */
+  type: string /**/;
+};

lib/messaging-api/model/acquisitionConditionResponse.ts

@@ -0,0 +1,27 @@
+/**
+ * LINE Messaging API
+ * This document describes LINE Messaging API.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { LotteryAcquisitionConditionResponse } from "./models.js";
+import { NormalAcquisitionConditionResponse } from "./models.js";
+import { ReferralAcquisitionConditionResponse } from "./models.js";
+
+export type AcquisitionConditionResponse =
+  | LotteryAcquisitionConditionResponse // lottery
+  | NormalAcquisitionConditionResponse // normal
+  | ReferralAcquisitionConditionResponse; // referral
+
+export type AcquisitionConditionResponseBase = {
+  /**
+   * Determines how the coupon is distributed or used.
+   */
+  type: string /**/;
+};

lib/messaging-api/model/cashBackFixedPriceInfoRequest.ts

@@ -0,0 +1,22 @@
+/**
+ * LINE Messaging API
+ * This document describes LINE Messaging API.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { CashBackPriceInfoRequest } from "./cashBackPriceInfoRequest.js";
+
+import { CashBackPriceInfoRequestBase } from "./models.js";
+
+export type CashBackFixedPriceInfoRequest = CashBackPriceInfoRequestBase & {
+  type: "fixed";
+  /**
+   */
+  fixedAmount?: number /**/;
+};

lib/messaging-api/model/cashBackFixedPriceInfoResponse.ts

@@ -0,0 +1,30 @@
+/**
+ * LINE Messaging API
+ * This document describes LINE Messaging API.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { CashBackPriceInfoResponse } from "./cashBackPriceInfoResponse.js";
+
+import { CashBackPriceInfoResponseBase } from "./models.js";
+
+export type CashBackFixedPriceInfoResponse = CashBackPriceInfoResponseBase & {
+  type: "fixed";
+  /**
+   * Currency code (e.g., JPY, THB, TWD).
+   */
+  currency?: CashBackFixedPriceInfoResponse.CurrencyEnum /**/;
+  /**
+   */
+  fixedAmount?: number /**/;
+};
+
+export namespace CashBackFixedPriceInfoResponse {
+  export type CurrencyEnum = "JPY" | "THB" | "TWD";
+}

lib/messaging-api/model/cashBackPercentagePriceInfoRequest.ts

@@ -0,0 +1,24 @@
+/**
+ * LINE Messaging API
+ * This document describes LINE Messaging API.
+ *
+ * The version of the OpenAPI document: 0.0.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { CashBackPriceInfoRequest } from "./cashBackPriceInfoRequest.js";
+
+import { CashBackPriceInfoRequestBase } from "./models.js";
+
+export type CashBackPercentagePriceInfoRequest =
+  CashBackPriceInfoRequestBase & {
+    type: "percentage";
+    /**
+     * Specifies the cashback rate as a percentage. Must be an integer between 1 and 99.
+     */
+    percentage?: number /**/;
+  };