> ## 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.

# 查询促销码

> Get detailed information about a specific promotion code.



## OpenAPI

````yaml GET /promotion-code/{id}
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:
  /promotion-code/{id}:
    get:
      summary: Get Promotion Code
      description: Get detailed information about a specific promotion code.
      operationId: getPromotionCode
      parameters:
        - $ref: '#/components/parameters/TimestampHeader'
        - name: id
          in: path
          description: Unique identifier of the promotion code
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Promotion code details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RPromotionCodeDetailResponse'
            '*/*':
              schema:
                $ref: '#/components/schemas/RPromotionCodeDetailResponse'
        '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:
    RPromotionCodeDetailResponse:
      type: object
      properties:
        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
        data:
          $ref: '#/components/schemas/ApiPromotionCodeDetailResponse'
      description: Body of the response message
    ApiPromotionCodeDetailResponse:
      type: object
      properties:
        couponId:
          type: string
          description: Associated coupon ID
        promotionCodeId:
          type: string
          description: Unique identifier of the promotion code
        code:
          type: string
          description: Customer-facing promotion code
        status:
          type: string
          description: Promotion code status
          enum:
            - active
            - inactive
            - archived
          example: active
        firstOrderOnly:
          type: boolean
          description: Whether this promotion code is limited to first orders only
        redemptionCount:
          type: integer
          format: int32
          description: Number of times this promotion code has been redeemed
        maxRedemptionLimit:
          type: integer
          format: int32
          description: Maximum total redemptions for this promotion code
        validPeriodEnd:
          type: integer
          format: int64
          description: >-
            Promotion code validity end time as a 13-digit Unix timestamp in
            milliseconds
          example: 1754819711382
        createTime:
          type: integer
          format: int64
          description: >-
            Promotion code creation time as a 13-digit Unix timestamp in
            milliseconds
          example: 1754819711382
        mirroring:
          type: boolean
          description: Whether this record is mirrored data
        customers:
          type: array
          description: Restricted customer details
          items:
            $ref: '#/components/schemas/CustomerInfo'
        perCustomerRedemptionLimit:
          type: integer
          format: int32
          description: Redemption limit per customer
        minimumSpend:
          type: object
          description: Minimum spend by currency. Key is an ISO currency code.
          additionalProperties:
            type: number
        currency:
          type: string
          description: First currency from minimumSpend, when available
        amount:
          type: number
          description: First amount from minimumSpend, when available
    CustomerInfo:
      type: object
      properties:
        customerId:
          type: string
          description: Customer ID
        name:
          type: string
          description: Customer name
        email:
          type: string
          description: Customer email address
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Your secret API key obtained from the Clink dashboard (Developers
        section)

````