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

# Get Coupon Details

> Retrieve a coupon, including the categories or products it applies to



## OpenAPI

````yaml get /v1/coupons/{coupon_id}
openapi: 3.1.1
info:
  title: HitPay API
  description: >-
    Accept PayNow, FPX, GrabPay, cards, and 40+ payment methods with a single
    API. Production base URL: https://api.hit-pay.com, Sandbox:
    https://api.sandbox.hit-pay.com
  version: '1.0'
servers:
  - url: https://api.hit-pay.com
    description: Production
  - url: https://api.sandbox.hit-pay.com
    description: Sandbox
security: []
paths:
  /v1/coupons/{coupon_id}:
    get:
      summary: Get Coupon Details
      description: Get a coupon, including the categories or products it applies to.
      operationId: get-coupon-details
      parameters:
        - name: X-BUSINESS-API-KEY
          in: header
          required: true
          style: simple
          explode: false
          schema:
            type: string
            example: b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d
        - name: coupon_id
          in: path
          required: true
          description: The coupon ID.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coupon'
              examples:
                Result:
                  value:
                    id: a304f0fd-4ebb-4a8f-bc90-c7341f90080c
                    business_id: 98567029-f559-49f9-916b-042a4255b32a
                    name: Year End Sale
                    code: YEAREND10
                    fixed_amount: 500
                    percentage: 0
                    coupons_left: 100
                    is_promo_banner: false
                    banner_text: null
                    created_at: '2026-10-19T13:23:03.000000Z'
                    updated_at: '2026-10-19T13:23:03.000000Z'
                    starts_at: '2026-10-31T16:00:00.000000Z'
                    ends_at: '2026-12-30T16:00:00.000000Z'
                    coupon_type: 2
                    minimum_cart_amount: 2000
                    deleted_at: null
                    applies_to_ids:
                      - id: 9bd48afd-ed47-4bdb-aac0-388d6b25d199
                        name: Apparels
        '403':
          description: The coupon belongs to another business
          content:
            application/json:
              examples:
                Result:
                  value:
                    message: ''
        '404':
          description: Coupon not found
          content:
            application/json:
              examples:
                Result:
                  value:
                    error_code: model_not_found
                    message: 'No query results for Coupon #<coupon_id>'
      deprecated: false
components:
  schemas:
    Coupon:
      type: object
      properties:
        id:
          type: string
          format: uuid
        business_id:
          type: string
          format: uuid
        name:
          type: string
        code:
          type: string
        fixed_amount:
          type: integer
          description: Fixed discount in minor units (cents).
        percentage:
          type: number
          description: Percentage discount as a fraction (`0.15` = 15%).
        coupons_left:
          type:
            - integer
            - 'null'
          description: Remaining uses; `null` = unlimited.
        is_promo_banner:
          type: boolean
        banner_text:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        starts_at:
          type:
            - string
            - 'null'
          format: date-time
          description: UTC.
        ends_at:
          type:
            - string
            - 'null'
          format: date-time
          description: UTC.
        coupon_type:
          type: integer
          enum:
            - 1
            - 2
            - 3
        minimum_cart_amount:
          type: integer
          description: Minimum cart amount in minor units (cents).
        deleted_at:
          type:
            - string
            - 'null'
          format: date-time
        applies_to_ids:
          type: array
          description: >-
            Categories or products the coupon applies to. Empty for
            `coupon_type` 1.
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.