Create Simulation

POST

/api/simulations/

Create a new simulation. Creates a test clock with virtual time for deterministic subscription testing.

AuthorizationBearer

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

This endpoint expects an object.

account_idstringRequired

Account this simulation belongs to

start_timedatetimeRequired

When the simulation's virtual timeline begins

descriptionstring or nullOptional

Optional human-readable description

Successful Response

idstring

account_idstring

virtual_clockdatetime

start_timedatetime

statusstring

descriptionstring or null

created_atdatetime

expires_atdatetime

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/simulations/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"account_id": "acc_9f8b7c6d5e4a3b2c1d0e",
>	"start_time": "2024-01-15T09:30:00Z"
>	}'

1	{
2	"id": "sim_123e4567-e89b-12d3-a456-426614174000",
3	"account_id": "acc_9f8b7c6d5e4a3b2c1d0e",
4	"virtual_clock": "2024-01-15T09:30:00Z",
5	"start_time": "2024-01-15T09:30:00Z",
6	"status": "active",
7	"description": "Initial simulation for subscription testing",
8	"created_at": "2024-01-15T09:30:00Z",
9	"expires_at": "2024-07-15T09:30:00Z"
10	}