Paddle Billing
Search

Get a run for a simulation

Returns a simulation run using its ID.

Use the include parameter to include related entities in the response.

Path Parameters

simulation_idstringrequired

Paddle ID of the simulation entity to work with.

simulation_run_idstringrequired

Paddle ID of the simulation run entity to work with.

Query Parameters

includearray[string]

Include related entities in the response.

Response

dataobject

Represents a simulation run entity.

idstring

Unique Paddle ID for this simulation run, prefixed with ntfsimrun_.

statusstring

Status of this simulation run.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

typestring

Single event sent for this simulation, in the format entity.event_type.

eventsarray[object]

Events associated with this simulation run. Paddle creates a list of events for each simulation runs. Returned when the include parameter is used with the events value.

idstring

Unique Paddle ID for this simulation event, prefixed with ntfsimevt_.

statusstring

Status of this simulation run log.

event_typestring

Type of event sent by Paddle, in the format entity.event_type.

payloadobject

Simulation payload. Pass a JSON object that matches the schema for an event type to simulate a custom payload. If omitted, Paddle populates with a demo example.

requestobject or null

Information about the request. Sent by Paddle as part of the simulation.

responseobject or null

Information about the response. Sent by the responding server for the notification setting.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.