Skip to main content
GET
/
simulations
/
{simulation_id}
Get a simulation
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paddle.com/simulations/{simulation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "data": {
    "id": "ntfsim_01j82d9tc19c67jds5vzbzjcns",
    "notification_setting_id": "ntfset_01j82d983j814ypzx7m1fw2jpz",
    "name": "Subscription created using pricing page on website",
    "type": "subscription_creation",
    "status": "active",
    "payload": null,
    "config": {
      "subscription_creation": {
        "options": {
          "customer_simulated_as": "existing_email_matched"
        }
      }
    },
    "last_run_at": null,
    "created_at": "2024-09-18T11:11:55.265125Z",
    "updated_at": "2024-09-18T11:54:18.543265Z"
  },
  "meta": {
    "request_id": "3db61fbc-dde6-4a33-9ac1-c2c781e569fc"
  }
}

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"

Response

OK

data
Single event · object
required

Single event simulations play a single event.

meta
Meta · object
required

Information about this response.