---
title: "Get a run for a simulation"
method: GET
path: "/simulations/{simulation_id}/runs/{simulation_run_id}"
tags: ["Simulation runs"]
---

# Get a run for a simulation

`GET /simulations/{simulation_id}/runs/{simulation_run_id}`

## Request

- Base URL: `https://sandbox-api.paddle.com`
- URL: `https://sandbox-api.paddle.com/simulations/{simulation_id}/runs/{simulation_run_id}`
- Auth: HTTP bearer

Returns a simulation run using its ID.

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

## Path parameters

- `simulation_id` string, required
- `simulation_run_id` string, required

## Query parameters

- `include` SimulationsRunIncludeEnum[]

## Response `200`

The request has succeeded.

- object
  - `data` union, required: Represents a simulation run entity.
    - SimulationRunSingleEventIncludesModel: Single event simulations play a single event.
      - `id` string, required: Unique Paddle ID for this simulation run, prefixed with `ntfsimrun_`.
      - `status` 'pending' | 'completed' | 'canceled', required: Status of this simulation run.
      - `created_at` string, date-time, required: RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
      - `updated_at` string, date-time, required: RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
      - `type` 'address.created' | 'address.imported' | 'address.updated' | 'adjustment.created' | 'adjustment.updated' | 'api_key.created' | 'api_key.expired' | 'api_key.expiring' | 'api_key.revoked' | 'api_key.updated' | 'api_key_exposure.created' | 'business.created' | 'business.imported' | 'business.updated' | 'client_token.created' | 'client_token.revoked' | 'client_token.updated' | 'customer.created' | 'customer.imported' | 'customer.updated' | 'discount.created' | 'discount.imported' | 'discount.updated' | 'discount_group.created' | 'discount_group.updated' | 'payment_method.saved' | 'payment_method.deleted' | 'payout.created' | 'payout.paid' | 'price.created' | 'price.imported' | 'price.updated' | 'product.created' | 'product.imported' | 'product.updated' | 'report.created' | 'report.updated' | 'subscription.activated' | 'subscription.canceled' | 'subscription.created' | 'subscription.imported' | 'subscription.past_due' | 'subscription.paused' | 'subscription.resumed' | 'subscription.trialing' | 'subscription.updated' | 'transaction.billed' | 'transaction.canceled' | 'transaction.completed' | 'transaction.created' | 'transaction.paid' | 'transaction.past_due' | 'transaction.payment_failed' | 'transaction.ready' | 'transaction.revised' | 'transaction.updated', required: Type of event sent by Paddle, in the format `entity.event_type`.
      - `events` SimulationEvent[]: 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.
        - `id` string, required: Unique Paddle ID for this simulation event, prefixed with `ntfsimevt_`.
        - `status` 'pending' | 'success' | 'failed' | 'aborted', required: Status of this simulation run log.
        - `event_type` 'address.created' | 'address.imported' | 'address.updated' | 'adjustment.created' | 'adjustment.updated' | 'api_key.created' | 'api_key.expired' | 'api_key.expiring' | 'api_key.revoked' | 'api_key.updated' | 'api_key_exposure.created' | 'business.created' | 'business.imported' | 'business.updated' | 'client_token.created' | 'client_token.revoked' | 'client_token.updated' | 'customer.created' | 'customer.imported' | 'customer.updated' | 'discount.created' | 'discount.imported' | 'discount.updated' | 'discount_group.created' | 'discount_group.updated' | 'payment_method.saved' | 'payment_method.deleted' | 'payout.created' | 'payout.paid' | 'price.created' | 'price.imported' | 'price.updated' | 'product.created' | 'product.imported' | 'product.updated' | 'report.created' | 'report.updated' | 'subscription.activated' | 'subscription.canceled' | 'subscription.created' | 'subscription.imported' | 'subscription.past_due' | 'subscription.paused' | 'subscription.resumed' | 'subscription.trialing' | 'subscription.updated' | 'transaction.billed' | 'transaction.canceled' | 'transaction.completed' | 'transaction.created' | 'transaction.paid' | 'transaction.past_due' | 'transaction.payment_failed' | 'transaction.ready' | 'transaction.revised' | 'transaction.updated', required: Type of event sent by Paddle, in the format `entity.event_type`.
        - `payload` SimulationPayload, required: Simulation payload. A JSON object that matches the schema for an event type.
        - `request` SimulationEventRequest, required: Information about the request. Sent by Paddle as part of the simulation.
          - `body` string, required: Request body sent by Paddle.
        - `response` SimulationEventResponse, required: Information about the response. Sent by the responding server for the notification setting.
          - `body` string, required: Response body sent by the responding server. May be empty for success responses.
          - `status_code` number, required: HTTP status code sent by the responding server.
        - `created_at` string, date-time, required: RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
        - `updated_at` string, date-time, required: RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
    - SimulationRunScenarioIncludesModel: Scenario simulations play all events sent for a subscription lifecycle event.
      - `id` string, required: Unique Paddle ID for this simulation run, prefixed with `ntfsimrun_`.
      - `status` 'pending' | 'completed' | 'canceled', required: Status of this simulation run.
      - `created_at` string, date-time, required: RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
      - `updated_at` string, date-time, required: RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
      - `type` 'subscription_creation' | 'subscription_renewal' | 'subscription_pause' | 'subscription_resume' | 'subscription_cancellation', required: Scenario for a simulation.
      - `events` SimulationEvent[]: 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.
        - `id` string, required: Unique Paddle ID for this simulation event, prefixed with `ntfsimevt_`.
        - `status` 'pending' | 'success' | 'failed' | 'aborted', required: Status of this simulation run log.
        - `event_type` 'address.created' | 'address.imported' | 'address.updated' | 'adjustment.created' | 'adjustment.updated' | 'api_key.created' | 'api_key.expired' | 'api_key.expiring' | 'api_key.revoked' | 'api_key.updated' | 'api_key_exposure.created' | 'business.created' | 'business.imported' | 'business.updated' | 'client_token.created' | 'client_token.revoked' | 'client_token.updated' | 'customer.created' | 'customer.imported' | 'customer.updated' | 'discount.created' | 'discount.imported' | 'discount.updated' | 'discount_group.created' | 'discount_group.updated' | 'payment_method.saved' | 'payment_method.deleted' | 'payout.created' | 'payout.paid' | 'price.created' | 'price.imported' | 'price.updated' | 'product.created' | 'product.imported' | 'product.updated' | 'report.created' | 'report.updated' | 'subscription.activated' | 'subscription.canceled' | 'subscription.created' | 'subscription.imported' | 'subscription.past_due' | 'subscription.paused' | 'subscription.resumed' | 'subscription.trialing' | 'subscription.updated' | 'transaction.billed' | 'transaction.canceled' | 'transaction.completed' | 'transaction.created' | 'transaction.paid' | 'transaction.past_due' | 'transaction.payment_failed' | 'transaction.ready' | 'transaction.revised' | 'transaction.updated', required: Type of event sent by Paddle, in the format `entity.event_type`.
        - `payload` SimulationPayload, required: Simulation payload. A JSON object that matches the schema for an event type.
        - `request` SimulationEventRequest, required: Information about the request. Sent by Paddle as part of the simulation.
          - `body` string, required: Request body sent by Paddle.
        - `response` SimulationEventResponse, required: Information about the response. Sent by the responding server for the notification setting.
          - `body` string, required: Response body sent by the responding server. May be empty for success responses.
          - `status_code` number, required: HTTP status code sent by the responding server.
        - `created_at` string, date-time, required: RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.
        - `updated_at` string, date-time, required: RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.
  - `meta` Meta, required: Information about this response.
    - `request_id` string, required: Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

## Other responses

- `default`: An unexpected error response.

## Changes

- **2026-07-09** (v1) `e1ac347eb3c5`: 1 info
  - api tag `Simulations` removed
- **2026-02-02** (v1) `9ba8be0f2006`: 9 breaking, 1 warning, 5 info
  - added the new path request parameter `simulation_id`
  - added the new path request parameter `simulation_run_id`
  - added `#/components/schemas/SimulationRunSingleEventIncludesModel, #/components/schemas/SimulationRunScenarioIncludesModel` to the `data` response property `oneOf` list for the response status `200`
  - the `data` response's property type changed from `object` to no type for status `200`
  - …11 more
- **2025-05-27** (v1) `e57c515077cc`: 15 warning
  - added the new `api_key.created` enum value to the `data/oneOf[subschema #1: Single event run]/allOf[subschema #1: SimulationRunSingleEvent]/type` response property for the response status `200`
  - added the new `api_key.created` enum value to the `data/oneOf[subschema #1: Single event run]/allOf[subschema #2]/events/items/event_type` response property for the response status `200`
  - added the new `api_key.created` enum value to the `data/oneOf[subschema #2: Scenario run]/allOf[subschema #2]/events/items/event_type` response property for the response status `200`
  - added the new `api_key.expired` enum value to the `data/oneOf[subschema #1: Single event run]/allOf[subschema #1: SimulationRunSingleEvent]/type` response property for the response status `200`
  - …11 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/paddlehq/apis/paddle-api/changes/simulations/:simulation_id/runs/:simulation_run_id/get.md)

---

[API](https://skmtc.dev/paddlehq/apis/paddle-api.md) - [All operations](https://skmtc.dev/paddlehq/apis/paddle-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paddlehq/apis/paddle-api/revisions/bbc0c72039c8?raw)