Sample - Stripe API
GET/v1/test_helpers/test_clocks/{test_clock}

Retrieve a test clock

Retrieves a single test clock by its identifier. Use expand when you need additional fields included in the returned test clock representation.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
test_clockstringrequired
The identifier of the test clock to retrieve. Maximum 5,000 characters.
expandarray<string>optional
Fields to expand in the response.

2 status codes
200Returns the test clock object with its creation time, frozen time, deletion schedule, status, status details, and other current properties.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
deletes_afterintegerrequired
Time at which this clock is scheduled to auto delete.
frozen_timeintegerrequired
Time at which all objects belonging to this clock are frozen.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
namestringoptional
The custom name supplied at creation.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:test_helpers.test_clock
statusstringrequired
The status of the Test Clock.
Allowed:advancinginternal_failureready
status_detailsobjectrequired
defaultError response.
errorobjectrequired

Error handling

test_clock must be no longer than 5,000 characters and must identify the test clock to retrieve. Use expand only for fields that can be expanded in the response.