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

# Advance Test Clock

> Advance a test clock to the target frozen timestamp



## OpenAPI

````yaml POST /subscription/test-clocks/{clockId}/advance
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: []
    timestamp: []
paths:
  /subscription/test-clocks/{clockId}/advance:
    post:
      tags:
        - Test Clock
      summary: Advance test clock
      description: Advance a test clock to the target frozen timestamp
      operationId: advanceTestClock
      parameters:
        - name: clockId
          in: path
          description: Unique identifier of the test clock
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestClockAdvanceApiRequest'
            examples:
              example:
                value:
                  targetFrozenTime: 1755078906689
      responses:
        '200':
          description: Test clock advance task created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockTaskRes'
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                type: string
components:
  schemas:
    TestClockAdvanceApiRequest:
      type: object
      description: Parameters required to advance a test clock
      required:
        - targetFrozenTime
      properties:
        targetFrozenTime:
          type: integer
          format: int64
          description: Target frozen timestamp in milliseconds since Unix epoch
    TestClockTaskRes:
      type: object
      description: Response object returned for a test clock task
      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/TestClockTaskApiVo'
    TestClockTaskApiVo:
      type: object
      description: Test clock advance task details
      properties:
        taskId:
          type: string
          description: Unique identifier of the task
        clockId:
          type: string
          description: Unique identifier of the related test clock
        subscriptionId:
          type: string
          description: Unique identifier of the related subscription
        fromTime:
          type: integer
          format: int64
          description: Starting frozen timestamp in milliseconds since Unix epoch
        toTime:
          type: integer
          format: int64
          description: Target frozen timestamp in milliseconds since Unix epoch
        status:
          type: string
          description: Current status of the task
          enum:
            - CREATED
            - SCANNING
            - EXECUTING
            - SUCCEEDED
            - FAILED
        lastEventId:
          type: string
          description: Last processed event identifier
        lastEventTime:
          type: integer
          format: int64
          description: Execution timestamp of the last processed event
        summary:
          type: string
          description: Task summary
        errorMessage:
          type: string
          description: Task error message when execution fails
        createTime:
          type: integer
          format: int64
          description: Unix timestamp when the task was created
        updateTime:
          type: integer
          format: int64
          description: Unix timestamp when the task was last updated
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Your secret API key obtained from the Clink dashboard (Developers
        section)
    timestamp:
      type: apiKey
      in: header
      name: X-Timestamp
      description: >-
        Current timestamp in milliseconds since Unix epoch (required for request
        signing)

````