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}Advance a test clockTest helper
Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
Parameters
- frozen_
timetimestampRequired The time to advance the test clock. Must be after the test clock’s current frozen time. Cannot be more than two intervals in the future from the shortest subscription in this test clock. If there are no subscriptions in this test clock, it cannot be more than two years in the future.
Returns
A TestClock object with status Advancing 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": "advancing"}