Pre-1.0 · one maintainer · Stripe and cards only · no SDKs (client libraries) yet · no production users yet. Docs describe v0.9.1 (29 Oct 2026) · What’s new →
Get a test clock by id
GET
/v1/test-clocks/{id}
const url = 'http://localhost:8080/v1/test-clocks/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://localhost:8080/v1/test-clocks/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Responses
Section titled “Responses”Clock
Media typeapplication/json
A clock for test mode. Customers and subscriptions attached to it are billed on its time, not the real time.
object
id
required
string
tenant_id
string
name
required
string
frozen_time
required
The clock’s current time.
string format: date-time
status
required
ready: it can be advanced or deleted. advancing: billing is
catching up to the new time. internal_failure: the last advance
failed partway; resume it with POST /v1/test-clocks/{id}/retry-advance.
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
last_failure_reason
Why the last advance failed. Cleared by the next successful advance.
string
last_advance_summary
What the latest advance did: the time span it covered and how many of each billing step it ran. Absent until the clock is first advanced.
object
advanced_from
required
string format: date-time
advanced_to
required
string format: date-time
invoices_generated
required
integer
trials_activated
required
integer
pauses_resumed
required
integer
thresholds_fired
required
integer
tax_retried
required
integer
charges_retried
required
integer
clawbacks_issued
required
integer
credits_expired
required
integer
dunning_advanced
required
integer
had_errors
required
True when a step failed. The counts then cover only the work done before the failure.
boolean
Example
{ "status": "ready"}Clock not found