List all test clocks Test helper
GET / v1 / test_helpers / test_clocks
Returns a list of your test clocks.
Parameters
No parameters.
More parameters
- ending _ before string
- limit integer
- starting _ after string
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.
Response
Delete a test clock Test helper
DELETE / v1 / test_helpers / test_clocks /:id
Deletes a test clock.
Parameters
No parameters.
Returns
The deleted TestClock object is returned upon success. Otherwise, this call raises an error.
Response
{ "id": "clock_1Mr3I22eZvKYlo2Ck0rgMqd7", "object": "test_helpers.test_clock", "deleted": true}
Advance a test clock Test helper
POST / v1 / test_helpers / test_clocks /:id / advance
Starts advancing a test clock to a specified time in the future. Advancement is done when status changes to Ready.
Parameters
- frozen _ time timestamp Required 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.
Response
{ "id": "clock_1Mr3I22eZvKYlo2Ck0rgMqd7", "object": "test_helpers.test_clock", "created": 1680112806, "deletes_after": 1680717606, "frozen_time": 1577836800, "livemode": false, "name": null, "status": "advancing"}