Test clocks simulate the passage of time in a sandbox. Instead of waiting for renewals, phase ends or dunning steps, advance the clock and every time-dependent operation on the resources attached to it runs as if that time had passed.
Sandbox only: a live workspace answers 403.
List test clocks
Returns all test clocks for the current sandbox. Only available in sandbox environments.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List test clocks › Responses
OK
Create a test clock
Creates a new test clock for time simulation in sandbox mode. Only available in sandbox environments.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Create a test clock › Request Body
frozen_atThe instant the clock starts at; now when absent.
nameThe clock's name; 'Default Clock' when absent.
Create a test clock › Responses
Created
Get a test clock
Returns a single test clock by ID.
path Parameters
idTest Clock UUID
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get a test clock › Responses
OK
Delete a test clock
Permanently deletes a test clock.
path Parameters
idTest Clock UUID
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Delete a test clock › Responses
No Content
Advance a test clock
Advances the test clock to a new frozen time, triggering any scheduled events in between.
path Parameters
idTest Clock UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Advance a test clock › Request Body
frozen_atThe instant to advance the clock to. It must be after the clock's frozen_at.
Advance a test clock › Responses
OK