Skip to main content
POST
Advance your simulation clock

Authorizations

Authorization
string
header
required

Your API key, e.g. Authorization: Bearer clmt_test_. Live keys use the clmt_live_ prefix.

Headers

Clemta-Version
string

Date-based API version to run this request against.

Example:

"2026-08-13"

Body

application/json
to
string<date-time>
required

The moment to advance the simulated world to. Must be after the clock's current simulated_time, at most five years ahead of it per call. Every renewal period due before this moment bills on your ledger during the call, and on a live clock each month boundary crossed drafts that month's statement.

Example:

"2027-09-08T00:00:00Z"

Response

The clock at its new simulated time.

object
enum<string>
required

Entity name.

Available options:
clock
id
string
required
Example:

"clk_0346sFPEvSkJvY8vt14NNw"

livemode
boolean
required

The mode this clock simulates. A test clock is always available. On the production API a live clock is refused - it is a sandbox rehearsal tool.

simulated_time
string<date-time>
required

The moment your simulated world has reached. It starts at the real current time when the clock is created and only ever moves forward. Advancing it processes every renewal and billing event that comes due up to this moment.

created_at
string<date-time>
required
advanced_at
string<date-time>

When the clock was last advanced. Absent until the first advance.