The Test Clock objectTest helper
Attributes
- idstring
Unique identifier for the object.
- objectstring
String representing the object’s type. Objects of the same type share the same value.
- createdtimestamp
Time at which the object was created. Measured in seconds since the Unix epoch.
- deletes_
aftertimestamp Time at which this clock is scheduled to auto delete.
- frozen_
timetimestamp Time at which all objects belonging to this clock are frozen.
- livemodeboolean
Has the value
trueif the object exists in live mode or the valuefalseif the object exists in test mode. - namenullable string
The custom name supplied at creation.
- statusenum
The status of the Test Clock.
Possible enum valuesadvancingIn the process of advancing time for the test clock objects.
internal_failureFailed to advance time. Future requests to advance time will fail.
readyAll test clock objects have advanced to the
frozen_time.
{ "id": "clock_1Mr3I22eZvKYlo2Ck0rgMqd7", "object": "test_helpers.test_clock", "created": 1680112806, "deletes_after": 1680717606, "frozen_time": 1577836800, "livemode": false, "name": null, "status": "ready"}Create a test clockTest helper
Creates a new test clock that can be attached to new customers and quotes.
Parameters
- frozen_
timetimestampRequired The initial frozen time for this test clock.
- namestring
The name for this test clock.
Returns
The newly created TestClock object is returned upon success. Otherwise, this call raises an error.
{ "id": "clock_1Mr3I22eZvKYlo2Ck0rgMqd7", "object": "test_helpers.test_clock", "created": 1680112806, "deletes_after": 1680717606, "frozen_time": 1577836800, "livemode": false, "name": null, "status": "ready"}Retrieve a test clockTest helper
Retrieves a test clock.
Parameters
No parameters.
Returns
Returns the TestClock object. Otherwise, this call raises an error.
{ "id": "clock_1Mr3I22eZvKYlo2Ck0rgMqd7", "object": "test_helpers.test_clock", "created": 1680112806, "deletes_after": 1680717606, "frozen_time": 1577836800, "livemode": false, "name": null, "status": "ready"}List all test clocksTest helper
Returns a list of your test clocks.
Parameters
No parameters.
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data property that contains an array of up to limit test clocks, starting after starting_after. Each entry in the array is a separate test clock object. If no more test clocks are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/test_helpers/test_clocks", "has_more": false, "data": [ { "id": "clock_1Mr3I22eZvKYlo2Ck0rgMqd7", "object": "test_helpers.test_clock", "created": 1680112806, "deletes_after": 1680717606, "frozen_time": 1577836800, "livemode": false, "name": null, "status": "ready" } {...} {...} ],}Delete a test clockTest helper
Deletes a test clock.
Parameters
No parameters.
Returns
The deleted TestClock object is returned upon success. Otherwise, this call raises an error.
{ "id": "clock_1Mr3I22eZvKYlo2Ck0rgMqd7", "object": "test_helpers.test_clock", "deleted": true}