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

# Get test clock state

> Returns the organization's current test clock state and latest durable run. Sandbox only.

Returns the organization's current test clock state and latest durable run. Sandbox only.


## OpenAPI

````yaml /openapi/es/rest/2026-08-27.json get /test-clock
openapi: 3.1.0
info:
  title: Commet API
  version: '2026-08-27'
  description: Billing and payments API for SaaS and AI products.
servers:
  - url: https://commet.co/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Test Clock
    description: >-
      Simulate the passage of time in sandbox to test billing flows. Mirrors
      Stripe test clocks: forward-only and sandbox-only.
  - name: Customers
  - name: Subscriptions
  - name: Plans
  - name: Markets
    description: >-
      Reusable country groups for market-specific prices and selectable price
      variants.
  - name: Offers
  - name: Promo Codes
  - name: Features
  - name: Usage
  - name: Seats
  - name: Quota
  - name: Add-ons
  - name: Portal
  - name: Credit Packs
  - name: Plan Groups
  - name: Invoices
  - name: Payments
    description: >-
      One-time payments with no subscription or plan. Charge a customer's saved
      payment method off-session, or create a payment link the customer opens to
      pay. Tax, invoice, and receipt are handled automatically.
  - name: Transactions
  - name: Webhooks
  - name: API Keys
  - name: Payouts
    description: >-
      Withdraw available balance to your bank and manage the payout account
      (verification + destination bank accounts).
  - name: Provisioning
    description: >-
      Take ownership of an organization an agent provisioned headlessly. The
      agent holds the API keys from the start; a human claims the account
      through a claim link.
paths:
  /test-clock:
    get:
      tags:
        - Test Clock
      summary: Get test clock state
      description: >-
        Returns the organization's current test clock state and latest durable
        run. Sandbox only.
      operationId: get-test-clock
      parameters:
        - name: Commet-Version
          in: header
          required: false
          description: >-
            API version used by this reference. Send this header to select this
            contract explicitly.
          schema:
            type: string
            default: '2026-08-27'
          example: '2026-08-27'
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              description: Maximum number of requests allowed in the current window.
              schema:
                type: string
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestClock'
              example:
                simulatedTime: '2026-09-07T12:00:00.000Z'
                isActive: true
                now: '2026-09-07T12:00:00.000Z'
                latestRun: null
                object: test_clock
                livemode: false
        '400':
          description: Bad request
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: validation_error
                  code: validation_error
                  message: The request contains an invalid parameter.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md
        '401':
          description: Unauthorized
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: authentication_error
                  code: unauthorized
                  message: A valid API key is required.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md
        '403':
          description: Forbidden
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: authentication_error
                  code: forbidden
                  message: You do not have permission to perform this operation.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md
        '429':
          description: Too many requests
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            RateLimit-Limit:
              description: Maximum number of requests allowed in the current window.
              schema:
                type: string
            RateLimit-Remaining:
              description: Requests remaining in the current window.
              schema:
                type: string
            RateLimit-Reset:
              description: Seconds until the rate limit window resets.
              schema:
                type: string
            Retry-After:
              description: Seconds to wait before retrying the request.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: rate_limit_error
                  code: rate_limited
                  message: >-
                    Too many requests. Retry after the interval specified in the
                    Retry-After header.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md
        '500':
          description: Internal server error
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  type: internal_error
                  code: internal_error
                  message: An unexpected error occurred while processing the request.
                  doc_url: >-
                    https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md
      x-codeSamples:
        - lang: typescript
          label: TypeScript
          source: |-
            import { Commet } from "@commet/node";

            const commet = new Commet({ apiKey: "ck_xxx" });

            const testClock = await commet.testClock.get();
        - lang: python
          label: Python
          source: |-
            from commet import Commet

            commet = Commet("ck_xxx")

            test_clock = commet.test_clock.get()
        - lang: go
          label: Go
          source: "client, err := commet.New(\"ck_xxx\")\nif err != nil {\n\tlog.Fatal(err)\n}\nctx := context.Background()\n\ntestClock, err := client.TestClock.Get(ctx)\nif err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import co.commet.Commet;

            var commet = Commet.builder().apiKey("ck_xxx").build();

            var testClock = commet.testClock().get();
        - lang: php
          label: PHP
          source: |-
            use Commet\Commet;

            $commet = new Commet('ck_xxx');

            $testClock = $commet->testClock->get();
components:
  headers:
    RequestId:
      description: >-
        Server-generated identifier that correlates this response with Platform
        logs.
      schema:
        type: string
        format: uuid
  schemas:
    TestClock:
      type: object
      properties:
        simulatedTime:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        isActive:
          type: boolean
        now:
          type: string
          format: date-time
        latestRun:
          anyOf:
            - type: object
              properties:
                id:
                  type: string
                status:
                  type: string
                  enum:
                    - pending
                    - running
                    - completed
                    - failed
                startedAtTime:
                  type: string
                  format: date-time
                targetTime:
                  type: string
                  format: date-time
                estimatedDeadlineCount:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                completedDeadlineCount:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                failedDeadlineCount:
                  type: integer
                  minimum: -9007199254740991
                  maximum: 9007199254740991
                error:
                  anyOf:
                    - type: string
                    - type: 'null'
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      kind:
                        type: string
                        enum:
                          - billing_cycle
                          - dunning_retry
                      status:
                        type: string
                        enum:
                          - pending
                          - processing
                          - completed
                          - failed
                      dueAt:
                        type: string
                        format: date-time
                      subscriptionId:
                        type: string
                      customerName:
                        anyOf:
                          - type: string
                          - type: 'null'
                      invoiceNumber:
                        anyOf:
                          - type: string
                          - type: 'null'
                      invoiceId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      outcome:
                        anyOf:
                          - type: string
                          - type: 'null'
                      detail:
                        anyOf:
                          - type: string
                          - type: 'null'
                      error:
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - kind
                      - status
                      - dueAt
                      - subscriptionId
                      - customerName
                      - invoiceNumber
                      - invoiceId
                      - outcome
                      - detail
                      - error
                    additionalProperties: false
              required:
                - id
                - status
                - startedAtTime
                - targetTime
                - estimatedDeadlineCount
                - completedDeadlineCount
                - failedDeadlineCount
                - error
                - items
              additionalProperties: false
            - type: 'null'
        object:
          type: string
          const: test_clock
        livemode:
          type: boolean
      required:
        - simulatedTime
        - isActive
        - now
        - latestRun
        - object
        - livemode
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
            param:
              type: string
            details: {}
            doc_url:
              type: string
          required:
            - type
            - code
            - message
            - doc_url
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

## Related topics

- [Advance test clock](/docs/es/api-reference/test-clock/advance-test-clock.md)
- [Testing](/docs/es/testing-sandbox.md)
- [CLI](/docs/es/cli.md)
- [Deprecated manual billing processing](/docs/es/api-reference/test-clock/process-test-clock-billing.md)
- [Ejemplos](/docs/es/examples.md)


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