Paddle Billing
Search

List simulation types

Returns a list of simulation types (events and scenarios) that you can choose from when creating simulations.

Response

dataarray[object]

Represents a simulation type.

namestring

Type of simulation sent by Paddle. Single event simulations are in the format entity.event_type; scenario simulations are in snake_case.

labelstring

Descriptive label for this simulation type. Typically gives more context about a scenario. Single event simulations are in the format entity.event_type.

descriptionstring

Short description of this simulation type.

groupstring

Group for this simulation type. Typically the entity that this event relates to.

typestring

Type of simulation.

eventsarray[string]

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

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.