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

# Advance a test clock

> Test keys only. Runs every renewal try, notice deadline and payment expiry due on the way.



## OpenAPI

````yaml /payments-api/openapi.json post /v1/test-helpers/clocks/{id}/advance
openapi: 3.1.0
info:
  title: TagadaPay Payments API
  version: '2026-11-01'
servers:
  - url: https://api.tagada.io
security: []
paths:
  /v1/test-helpers/clocks/{id}/advance:
    post:
      tags:
        - test_helpers
      summary: Advance a test clock
      description: >-
        Test keys only. Runs every renewal try, notice deadline and payment
        expiry due on the way.
      operationId: testHelpers.clocks.advance
      parameters:
        - in: path
          name: id
          required: true
          schema:
            pattern: ^clk_[0-9a-hjkmnp-tv-z]{26}$
            type: string
        - in: header
          name: payments-account
          required: false
          schema:
            type: string
        - in: header
          name: payments-version
          required: false
          schema:
            enum:
              - '2026-11-01'
            type: string
        - in: header
          name: idempotency-key
          required: true
          schema:
            maxLength: 255
            minLength: 1
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdvanceTestClock'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClock'
          description: Test clock.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockApiError'
          description: parameter_invalid, parameter_missing, amount_out_of_range
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockApiError'
          description: authentication_required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockApiError'
          description: permission_denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockApiError'
          description: resource_not_found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockApiError'
          description: idempotency_key_reused, idempotency_key_in_progress
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockApiError'
          description: rate_limited
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockApiError'
          description: internal_error
        '501':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClockApiError'
          description: not_implemented
      security:
        - bearerAuth: []
components:
  schemas:
    AdvanceTestClock:
      additionalProperties: false
      properties:
        frozen_at:
          format: date-time
          type: string
      required:
        - frozen_at
      type: object
    TestClock:
      properties:
        created_at:
          format: date-time
          type: string
        frozen_at:
          format: date-time
          type: string
        id:
          pattern: ^clk_[0-9a-hjkmnp-tv-z]{26}$
          type: string
        mode:
          enum:
            - test
          type: string
        object:
          enum:
            - test_clock
          type: string
      required:
        - id
        - object
        - mode
        - frozen_at
        - created_at
      type: object
    TestClockApiError:
      properties:
        error:
          properties:
            code:
              $ref: '#/components/schemas/TestClockErrorCode'
            details:
              additionalProperties: {}
              type: object
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            request_id:
              type: string
            type:
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - unavailable_error
              type: string
          required:
            - type
            - code
            - message
            - param
            - request_id
          type: object
      required:
        - error
      type: object
    TestClockErrorCode:
      enum:
        - amount_out_of_range
        - authentication_required
        - idempotency_key_in_progress
        - idempotency_key_reused
        - internal_error
        - not_implemented
        - parameter_invalid
        - parameter_missing
        - permission_denied
        - rate_limited
        - resource_not_found
      type: string
      x-extensible-enum:
        - amount_out_of_range
        - authentication_required
        - idempotency_key_in_progress
        - idempotency_key_reused
        - internal_error
        - not_implemented
        - parameter_invalid
        - parameter_missing
        - permission_denied
        - rate_limited
        - resource_not_found
  securitySchemes:
    bearerAuth:
      description: >-
        Secret, platform or publishable API key. Platform keys require
        Payments-Account.
      scheme: bearer
      type: http

````

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