> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clinkbill.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Coupons

> List coupons under your current merchant account with optional filters.



## OpenAPI

````yaml GET /coupon
openapi: 3.1.0
info:
  title: Clink API
  description: >-
    Official API documentation for Clink's payment processing platform. This API
    enables merchants to create and manage payment sessions, handle
    subscriptions, and process transactions.
  version: 1.0.0
servers:
  - url: https://uat-api.clinkbill.com/api/
security:
  - ApiKeyAuth: []
paths:
  /coupon:
    get:
      summary: List Coupons
      description: List coupons under your current merchant account with optional filters.
      operationId: listCoupons
      parameters:
        - $ref: '#/components/parameters/TimestampHeader'
        - name: discountType
          in: query
          description: Discount type used to filter coupons
          required: false
          schema:
            type: string
            enum:
              - percentage
              - fixed_amount
        - name: durationType
          in: query
          description: Discount duration type used to filter coupons
          required: false
          schema:
            type: string
            enum:
              - once
              - repeating
              - forever
        - name: pageNum
          in: query
          description: Current page number. Defaults to 1.
          required: false
          schema:
            type: integer
            format: int32
            default: 1
        - name: pageSize
          in: query
          description: >-
            Number of records per page. Defaults to 20. The maximum is 50;
            larger values are capped at 50.
          required: false
          schema:
            type: integer
            format: int32
            default: 20
            maximum: 50
      responses:
        '200':
          description: Coupons retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableDataInfoApiCouponInfoResponse'
            '*/*':
              schema:
                $ref: '#/components/schemas/TableDataInfoApiCouponInfoResponse'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                type: string
components:
  parameters:
    TimestampHeader:
      name: X-Timestamp
      in: header
      required: true
      description: >-
        Current timestamp in milliseconds since Unix epoch (required for request
        signing)
      schema:
        type: string
        example: '1783513683000'
  schemas:
    TableDataInfoApiCouponInfoResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of records
          format: int64
        rows:
          type: array
          description: List of data
          items:
            $ref: '#/components/schemas/ApiCouponInfoResponse'
        code:
          type: integer
          description: Response status code, 200 when success
          format: int32
          example: 200
        msg:
          type: string
          example: success
          description: Brief description of what happened, 'success' when happy case
      description: Table Paging Data Object
    ApiCouponInfoResponse:
      type: object
      properties:
        couponId:
          type: string
          description: Unique identifier of the coupon
        couponName:
          type: string
          description: Coupon name
        discountType:
          type: string
          description: Discount type
          enum:
            - percentage
            - fixed_amount
        percentage:
          type: number
          description: Percentage discount
        fixedAmounts:
          type: object
          description: Fixed discount amount by currency
          additionalProperties:
            type: number
        durationType:
          type: string
          description: Discount duration type
          enum:
            - once
            - repeating
            - forever
        durationMonths:
          type: integer
          format: int32
          description: Number of billing periods for repeating coupons
        maxRedemptionCount:
          type: integer
          format: int32
          description: Maximum total redemptions for this coupon
        redeemedCount:
          type: integer
          format: int32
          description: Number of times this coupon has been redeemed
        validPeriodEnd:
          type: integer
          format: int64
          description: >-
            Coupon validity end time as a 13-digit Unix timestamp in
            milliseconds
          example: 1754819711382
        mirroring:
          type: boolean
          description: Whether this record is mirrored data
        terms:
          type: string
          description: Human-readable coupon terms
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Your secret API key obtained from the Clink dashboard (Developers
        section)

````