Advance test clock
Moves the test clock forward, by a number of days (advanceDays) or to an absolute instant (frozenTime). The clock can only move forward. Sandbox only.
Moves the test clock forward, by a number of days (advanceDays) or to an absolute instant (frozenTime). The clock can only move forward. Sandbox only.
Authorization
ApiKeyAuth x-api-key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
advanceDays?integer
Range
0 < value <= 9007199254740991frozenTime?string
Format
date-timeResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/test-clock" \ -H "Content-Type: application/json" \ -d '{}'{ "success": true, "data": { "simulatedTime": "2019-08-24T14:15:22Z", "isActive": true, "now": "2019-08-24T14:15:22Z", "object": "test_clock", "livemode": true }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}{ "success": false, "error": { "type": "string", "code": "string", "message": "string", "param": "string", "details": null, "doc_url": "string" }}