Skip to main content
GET
/
simulations
/
{simulation_id}
/
runs
/
{simulation_run_id}
/
events
/
{simulation_event_id}
Get an event for a simulation run
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/simulations/{simulation_id}/runs/{simulation_run_id}/events/{simulation_event_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "ntfsimevt_01j82hf8jrwjsf9337a35tqghp",
    "status": "success",
    "event_type": "adjustment.updated",
    "payload": {
      "id": "adj_01hvgf2s84dr6reszzg29zbvcm",
      "items": [
        {
          "id": "adjitm_01hvgf2s84dr6reszzg2gx70gj",
          "type": "partial",
          "amount": "100",
          "totals": {
            "tax": "8",
            "total": "100",
            "subtotal": "92"
          },
          "item_id": "txnitm_01hvcc94b7qgz60qmrqmbm19zw",
          "proration": null
        }
      ],
      "action": "refund",
      "reason": "error",
      "status": "pending_approval",
      "totals": {
        "fee": "5",
        "tax": "8",
        "total": "100",
        "earnings": "87",
        "subtotal": "92",
        "currency_code": "USD"
      },
      "created_at": "2024-04-15T08:48:20.239695Z",
      "updated_at": "2024-04-15T08:48:20.239695Z",
      "customer_id": "ctm_01hv6y1jedq4p1n0yqn5ba3ky4",
      "currency_code": "USD",
      "payout_totals": {
        "fee": "5",
        "tax": "8",
        "total": "100",
        "earnings": "87",
        "subtotal": "92",
        "currency_code": "USD"
      },
      "transaction_id": "txn_01hvcc93znj3mpqt1tenkjb04y",
      "subscription_id": "sub_01hvccbx32q2gb40sqx7n42430",
      "credit_applied_to_balance": null
    },
    "request": {
      "body": "{\"event_id\":\"ntfsimevt_01j82hf8jrwjsf9337a35tqghp\",\"event_type\":\"adjustment.updated\",\"occurred_at\":\"2024-09-18T12:24:47.960617Z\",\"data\":{\"id\":\"adj_01hvgf2s84dr6reszzg29zbvcm\",\"items\":[{\"id\":\"adjitm_01hvgf2s84dr6reszzg2gx70gj\",\"type\":\"partial\",\"amount\":\"100\",\"totals\":{\"tax\":\"8\",\"total\":\"100\",\"subtotal\":\"92\"},\"item_id\":\"txnitm_01hvcc94b7qgz60qmrqmbm19zw\",\"proration\":null}],\"action\":\"refund\",\"reason\":\"error\",\"status\":\"pending_approval\",\"totals\":{\"fee\":\"5\",\"tax\":\"8\",\"total\":\"100\",\"earnings\":\"87\",\"subtotal\":\"92\",\"currency_code\":\"USD\"},\"created_at\":\"2024-04-15T08:48:20.239695Z\",\"updated_at\":\"2024-04-15T08:48:20.239695Z\",\"customer_id\":\"ctm_01hv6y1jedq4p1n0yqn5ba3ky4\",\"currency_code\":\"USD\",\"payout_totals\":{\"fee\":\"5\",\"tax\":\"8\",\"total\":\"100\",\"earnings\":\"87\",\"subtotal\":\"92\",\"currency_code\":\"USD\"},\"transaction_id\":\"txn_01hvcc93znj3mpqt1tenkjb04y\",\"subscription_id\":\"sub_01hvccbx32q2gb40sqx7n42430\",\"credit_applied_to_balance\":null}}"
    },
    "response": {
      "body": "{\"status\":\"SUCCESS\",\"message\":\"Request handled by Hookdeck. Check your dashboard to inspect the request: https://dashboard.hookdeck.com/requests/req_6ob9lGLoCA2qKWS6VGXR\",\"request_id\":\"req_6ob9lGLoCA2qKWS6VGXR\"}",
      "status_code": 200
    },
    "created_at": "2024-09-18T12:24:47.960617Z",
    "updated_at": "2024-09-18T12:24:48.309530Z"
  },
  "meta": {
    "request_id": "76421aed-4a64-4eb6-b14e-72407f5ec40e"
  }
}

Authorizations

Authorization
string
header
required

Requests are authenticated with API keys. Provide your API key as a Bearer token in the Authorization header.

API keys are assigned permissions, granting them access to entities and operations. Each endpoint may require one or more permissions, defined with the x-permissions extension. Values for include parameters may require specific permissions as defined in the x-enum-permissions extension. See all available permissions in the permission schema or documentation.

Get an API key and select the permissions you need from the Paddle dashboard under Paddle > Developer Tools > Authentication.

Path Parameters

simulation_id
string
required

Paddle ID of the simulation entity to work with.

Example:

"ntfsim_01gt261ms8ew72a0vnm5p5ne2q"

simulation_run_id
string
required

Paddle ID of the simulation run entity to work with.

Example:

"ntfsimrun_01gt261ms8ew72a0vnm5p5ne2q"

simulation_event_id
string
required

Paddle ID of the simulation event entity to work with.

Example:

"ntfsimevt_01gt261ms8ew72a0vnm5p5ne2q"

Response

OK

data
SimulationEvent · object
required

Represents a simulation event.

meta
Meta · object
required

Information about this response.