Create a test clock
Creates a frozen clock in the sandbox. Customers created with test_clock run every time-based process on it: confirmation windows, reversal horizons, dispute deadlines, hold and grant expiry, periods and invoices. Advance it to run a month of settlement in seconds. Clocks are deleted after 30 days.
Authentication
AuthorizationBearer
A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.
Request
This endpoint expects an object.
frozen_time
The clock's starting time.
name
Response
The new test clock.
id
object
frozen_time
status
Allowed values:
deletes_at
livemode
created_at
name
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error