The test clock object

A clock for test mode. Customers and subscriptions attached to it are billed on its time, not the real time.

Fields

Field	Type	Always present	What it means
id	string	Yes
tenant_id	string	No
name	string	Yes
frozen_time	string (date-time)	Yes	The clock’s current time.
status	enum	Yes	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. One of: ready, advancing, internal_failure.
created_at	string (date-time)	Yes
updated_at	string (date-time)	Yes
last_failure_reason	string	No	Why the last advance failed. Cleared by the next successful advance.
last_advance_summary	Test clock advance summary	No	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.

Test clock 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.

Field	Type	Always present	What it means
advanced_from	string (date-time)	Yes
advanced_to	string (date-time)	Yes
invoices_generated	integer	Yes
trials_activated	integer	Yes
pauses_resumed	integer	Yes
thresholds_fired	integer	Yes
tax_retried	integer	Yes
charges_retried	integer	Yes
clawbacks_issued	integer	Yes
credits_expired	integer	Yes
dunning_advanced	integer	Yes
had_errors	boolean	Yes	True when a step failed. The counts then cover only the work done before the failure.