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

# Get clock state

> Returns the current simulated time (test mode only).



## OpenAPI

````yaml GET /admin/clock
openapi: 3.0.3
info:
  title: Plinth API
  version: 0.9.0
  description: >
    Recurring billing for Nigerian SaaS — card charging, bank transfers via
    virtual accounts,

    proration, dunning, and recovery in one API.


    All amounts are in **kobo** (1/100th of a Naira). ₦5,000 = `500000`.
servers:
  - url: https://api.useplinth.com
    description: Production
  - url: http://localhost:7331
    description: Local development
security:
  - BearerAuth: []
tags:
  - name: Sandbox
    description: Create an isolated sandbox environment for testing. No auth required.
  - name: Customers
    description: Who you are billing. One customer can have multiple subscriptions.
  - name: Plans
    description: Plan groups and the plans within them. Customers subscribe to plans.
  - name: Subscriptions
    description: The recurring billing relationship between a customer and a plan.
  - name: Virtual Accounts
    description: Dedicated bank account numbers for customers who pay by transfer.
  - name: Invoices
    description: Created at each billing cycle. Tracks what a customer owes for a period.
  - name: Webhooks
    description: >-
      Register endpoints that receive signed, retried events. See Receiving
      webhooks.
  - name: Admin
    description: Test clock control, billing tick, and suspense resolution. Test-mode only.
paths:
  /admin/clock:
    get:
      tags:
        - Admin
      summary: Get current clock state
      description: Returns the current simulated time (test mode only).
      operationId: get-clock
      responses:
        '200':
          description: Clock state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClockState'
              example:
                object: clock_state
                mode: test
                simulated_now: '2026-07-01T00:00:00Z'
                updated_at: '2026-06-14T10:00:00Z'
      security: []
components:
  schemas:
    ClockState:
      type: object
      properties:
        object:
          type: string
          enum:
            - clock_state
        mode:
          type: string
          enum:
            - real
            - test
        simulated_now:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        Use `sk_test_` keys for sandbox. Use `sk_live_` keys for production.
        Obtain your key from the dashboard.

````