Get a simulation

Permission required

gethttps://api.paddle.com/simulations/{simulation_id}

Returns a simulation using its ID.

simulation_idstringrequired

Paddle ID of the simulation entity to work with.

dataobject

Represents a simulation entity.

One of:

Single eventScenario

confignull

Configuration for scenario simulations. null for single events.

created_atstring<date-time>

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

idstring

Unique Paddle ID for this simulation, prefixed with ntfsim_.

last_run_atstring<date-time> or null

RFC 3339 datetime string of when this simulation was last run. null until run. Set automatically by Paddle.

namestring

Name of this simulation.

notification_setting_idstring

Paddle ID of the notification setting where this simulation is sent, prefixed with ntfset_.

payloadobject or null

Simulation payload.

statusstring

Whether this entity can be used in Paddle.

typestring

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

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.

Response

AI AssistantBeta

If you have made a purchase through Paddle, go to paddle.net instead.

Protected by hCaptcha