Update a simulation

Permission required

patchhttps://api.paddle.com/simulations/{simulation_id}

Updates a simulation using its ID.

For scenario simulations, you can optionally include a config.entities object in the request body with entity IDs to populate simulated webhook payloads with real data. The API key making the request needs read permissions:

For the entities you provided, or the request fails.
For related entities which aren't nested in the entities you provided, or static examples will be used instead.

For example, when updating a subscription renewal scenario simulation with an API key that has a subscription.read permission but not a transaction.read permission, the request succeeds and the subscription data will be used in simulated payloads, but the related transaction data won't be used in payloads and falls back to a static example.

If you don't provide a config.entities object, simulated webhook payloads are populated with static examples.

If successful, your response includes a copy of the updated simulation entity.

Path Parameters

simulation_idstringrequired

Paddle ID of the simulation entity to work with.

Request Body

One of:

Single eventScenario

notification_setting_idstring

Paddle ID of the notification setting where this simulation is sent, prefixed with ntfset_.

namestring

Name of this simulation.

statusstring

Whether this entity can be used in Paddle.

typestring

Single event sent for this simulation, in the format entity.event_type.

payloadobject or null

Simulation payload. Pass a JSON object that matches the schema for an event type to simulate a custom payload. Set to null to clear and populate with a demo example.

Response

dataobject

Represents a simulation entity.

One of:

Single eventScenario

idstring

Unique Paddle ID for this simulation, prefixed with ntfsim_.

statusstring

Whether this entity can be used in Paddle.

notification_setting_idstring

Paddle ID of the notification setting where this simulation is sent, prefixed with ntfset_.

namestring

Name of this simulation.

typestring

Single event sent for this simulation, in the format entity.event_type.

payloadobject or null

Simulation payload.

confignull

Configuration for scenario simulations. null for single events.

last_run_atstring<date-time> or null

RFC 3339 datetime string of when this simulation was last run. null until run. Set automatically by Paddle.

created_atstring<date-time>

RFC 3339 datetime string of when this entity was created. Set automatically by Paddle.

updated_atstring<date-time>

RFC 3339 datetime string of when this entity was updated. Set automatically by Paddle.

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.

Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
1{
2  "name": "Refund approved",
3  "type": "adjustment.updated",
4  "payload": {
5    "id": "adj_01hvgf2s84dr6reszzg29zbvcm",
6    "action": "refund",
7    "transaction_id": "txn_01hvcc93znj3mpqt1tenkjb04y",
8    "subscription_id": "sub_01hvccbx32q2gb40sqx7n42430",
9    "customer_id": "ctm_01hrffh7gvp29kc7xahm8wddwa",
10    "reason": "error",
11    "credit_applied_to_balance": null,
12    "currency_code": "USD",
13    "status": "approved",
14    "items": [
15      {
16        "id": "adjitm_01hvgf2s84dr6reszzg2gx70gj",
17        "item_id": "txnitm_01hvcc94b7qgz60qmrqmbm19zw",
18        "type": "partial",
19        "amount": "100",
20        "proration": null,

Response