Simulation run events

List events for a simulation run

Changed on

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

get/simulations/{simulation_id}/runs/{simulation_run_id}/events

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

simulation_idstring required

Paddle ID of the simulation entity to work with.

simulation_run_idstring required

Paddle ID of the simulation run entity to work with.

Query parameters

idstring[]

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

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.

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.

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.

Headers

Skip-Countstring

Set to true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "id": "ntfsimevt_01hvg8ykjrcdr4jvv9rqcbkhfa",
      "created_at": "2024-10-12T07:20:50.52Z",
      "updated_at": "2024-10-13T07:20:50.52Z"
    }
  ],
  "meta": {
    "request_id": "b15ec92e-8688-40d4-a04d-f44cbec93355",
    "pagination": {
      "estimated_total": 999
    }
  }
}

Changes

    • info

      api tag Simulations removed

    • info

      added the new optional header request parameter Skip-Count

    • breaking

      added the new path request parameter simulation_id

    • breaking

      added the new path request parameter simulation_run_id

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from object null to no type for status

    • breaking

      the // response's property type changed from object null to no type for status

    • breaking

      the // response's property type changed from string to no type for status

    • breaking

      the // response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api tag Simulations added

    • info

      added to the response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added to the // response property allOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      added subschema #2 to the // response property anyOf list for the response status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      removed the aborted enum value from the // response property for the response status

    • info

      removed the address.created enum value from the // response property for the response status

    • info

      removed the address.imported enum value from the // response property for the response status

    • info

      removed the address.updated enum value from the // response property for the response status

    • info

      removed the adjustment.created enum value from the // response property for the response status

    • info

      removed the adjustment.updated enum value from the // response property for the response status

    • info

      removed the api_key.created enum value from the // response property for the response status

    • info

      removed the api_key.expired enum value from the // response property for the response status

    • info

      removed the api_key.expiring enum value from the // response property for the response status

    • info

      removed the api_key.revoked enum value from the // response property for the response status

    • info

      removed the api_key.updated enum value from the // response property for the response status

    • info

      removed the business.created enum value from the // response property for the response status

    • info

      removed the business.imported enum value from the // response property for the response status

    • info

      removed the business.updated enum value from the // response property for the response status

    • info

      removed the customer.created enum value from the // response property for the response status

    • info

      removed the customer.imported enum value from the // response property for the response status

    • info

      removed the customer.updated enum value from the // response property for the response status

    • info

      removed the discount.created enum value from the // response property for the response status

    • info

      removed the discount.imported enum value from the // response property for the response status

    • info

      removed the discount.updated enum value from the // response property for the response status

    • info

      removed the failed enum value from the // response property for the response status

    • info

      removed the payment_method.deleted enum value from the // response property for the response status

    • info

      removed the payment_method.saved enum value from the // response property for the response status

    • info

      removed the payout.created enum value from the // response property for the response status

    • info

      removed the payout.paid enum value from the // response property for the response status

    • info

      removed the pending enum value from the // response property for the response status

    • info

      removed the price.created enum value from the // response property for the response status

    • info

      removed the price.imported enum value from the // response property for the response status

    • info

      removed the price.updated enum value from the // response property for the response status

    • info

      removed the product.created enum value from the // response property for the response status

    • info

      removed the product.imported enum value from the // response property for the response status

    • info

      removed the product.updated enum value from the // response property for the response status

    • info

      removed the report.created enum value from the // response property for the response status

    • info

      removed the report.updated enum value from the // response property for the response status

    • info

      removed the subscription.activated enum value from the // response property for the response status

    • info

      removed the subscription.canceled enum value from the // response property for the response status

    • info

      removed the subscription.created enum value from the // response property for the response status

    • info

      removed the subscription.imported enum value from the // response property for the response status

    • info

      removed the subscription.past_due enum value from the // response property for the response status

    • info

      removed the subscription.paused enum value from the // response property for the response status

    • info

      removed the subscription.resumed enum value from the // response property for the response status

    • info

      removed the subscription.trialing enum value from the // response property for the response status

    • info

      removed the subscription.updated enum value from the // response property for the response status

    • info

      removed the success enum value from the // response property for the response status

    • info

      removed the transaction.billed enum value from the // response property for the response status

    • info

      removed the transaction.canceled enum value from the // response property for the response status

    • info

      removed the transaction.completed enum value from the // response property for the response status

    • info

      removed the transaction.created enum value from the // response property for the response status

    • info

      removed the transaction.paid enum value from the // response property for the response status

    • info

      removed the transaction.past_due enum value from the // response property for the response status

    • info

      removed the transaction.payment_failed enum value from the // response property for the response status

    • info

      removed the transaction.ready enum value from the // response property for the response status

    • info

      removed the transaction.revised enum value from the // response property for the response status

    • info

      removed the transaction.updated enum value from the // response property for the response status

    • info

      the // response's property pattern ^ntfsimevt_[a-z\d]{26}$ was removed for the status