Paddle Billing
Search

List events for a simulation run

Returns a paginated list of simulations. Use the query parameters to page through results.

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

afterstring

Return entities after the specified Paddle ID when working with paginated endpoints. Used in the meta.pagination.next URL in responses for list operations.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].

Valid fields for ordering: id.

per_pageinteger

Set how many entities are returned per page. Paddle returns the maximum number of results if a number greater than the maximum is requested. Check meta.pagination.per_page in the response to see how many were returned.

Default: 50; Maximum: 200.

idarray[string]

Return only the IDs specified. Use a comma-separated list to get multiple entities.

Response

dataarray[object]

Represents a simulation event.

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.

paginationobject

Keys used for working with paginated results.