Test Clock

id
Type: string
required

Unique identifier for the test clock.
object
enum
const:
test_clock
required
livemode
Type: falseenum
const:
false
required

Always false because test clocks are available only in a sandbox.
status
Type: enum
required
values
- ready
  
  The clock is ready for an advance.
- advancing
  
  An advance is in progress.
- blocked
  
  The clock has stopped before completing the advance.
- deleted
  
  The clock has been deleted and cannot advance.
frozen_time
Type: stringFormat: date-time
required

Time currently reached by the clock.
metadata
Type: object
required

Key-value metadata. An empty object is returned when none is set.

Properties: 1
created
Type: stringFormat: date-time
required

Time the clock was created.
updated
Type: stringFormat: date-time
required

Time the clock was last updated.
deleted_at
Type: stringFormat: date-time

Time the clock was deleted, when applicable.