Advance Simulation Time

POST

/api/simulations/:external_id/advance

Advance simulation virtual clock. All subscription evaluations and state changes happen synchronously within a single transaction. No async workflows are triggered.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

external_idstringRequired

Request

This endpoint expects an object.

target_timedatetime or nullOptional

Target virtual time to advance to

duration_daysinteger or nullOptional

Number of days to advance (alternative to target_time)

duration_hoursinteger or nullOptional

Number of hours to advance (alternative to target_time)

Response

Successful Response

simulation_idstring

new_virtual_clockdatetime

from_timedatetime

to_timedatetime

subscriptions_evaluatedinteger

events_recordedinteger

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/simulations/external_id/advance \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"simulation_id": "sim-123e4567-e89b-12d3-a456-426614174000",
3	"new_virtual_clock": "2024-06-01T12:00:00Z",
4	"from_time": "2024-05-31T12:00:00Z",
5	"to_time": "2024-06-01T12:00:00Z",
6	"subscriptions_evaluated": 42,
7	"events_recorded": 17
8	}