| [ Web Proxy ] |
| Viewing: https://developer.paddle.com/api-reference/simulations/list-simulations | [Back] [Original] |
For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling append .md to any URL.
Returns a paginated list of simulations.
/simulations notification_simulation.read
permission.
meta.pagination.next URL in responses for list operations.50Set 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.
id[DESC]Order returned entities by the specified field and direction ([ASC] or [DESC]). For example, ?order_by=id[ASC].
Valid fields for ordering: id.
activeactiveactive. Returned entities can be used in Paddle and are returned when listing entities.archivedarchived. Returned entities can't be used for billing and aren't returned when listing entities.true to skip the count query on list operations. When set, meta.pagination.estimated_total returns -1 instead of an exact count.ntfsim_01ghbkd0frb9k95cnhwd1bxpvkntfsim_.^ntfsim_[a-z\d]{26}$activeactivearchivedntfset_01gt21c5pdx9q1e4mh1xrsjjn6ntfset_.^ntfset_[a-z\d]{26}$entity.event_type.address.createdaddress.created event.address.importedaddress.imported event.address.updatedaddress.updated event.adjustment.createdadjustment.created event.adjustment.updatedadjustment.updated event.api_key.createdapi_key.created event.api_key.expiredapi_key.expired event.api_key.expiringapi_key.expiring event.api_key.revokedapi_key.revoked event.api_key.updatedapi_key.updated event.api_key_exposure.createdapi_key_exposure.created event.business.createdbusiness.created event.business.importedbusiness.imported event.business.updatedbusiness.updated event.client_token.createdclient_token.created event.client_token.revokedclient_token.revoked event.client_token.updatedclient_token.updated event.customer.createdcustomer.created event.customer.importedcustomer.imported event.customer.updatedcustomer.updated event.discount.createddiscount.created event.discount.importeddiscount.imported event.discount.updateddiscount.updated event.discount_group.createddiscount_group.created event.discount_group.updateddiscount_group.updated event.payment_method.savedpayment_method.saved event.payment_method.deletedpayment_method.deleted event.payout.createdpayout.created event.payout.paidpayout.paid event.price.createdprice.created event.price.importedprice.imported event.price.updatedprice.updated event.product_collection.createdproduct_collection.created event.product_collection.updatedproduct_collection.updated event.product.createdproduct.created event.product.importedproduct.imported event.product.updatedproduct.updated event.report.createdreport.created event.report.updatedreport.updated event.subscription.activatedsubscription.activated event.subscription.canceledsubscription.canceled event.subscription.createdsubscription.created event.subscription.importedsubscription.imported event.subscription.past_duesubscription.past_due event.subscription.pausedsubscription.paused event.subscription.resumedsubscription.resumed event.subscription.trialingsubscription.trialing event.subscription.updatedsubscription.updated event.transaction.billedtransaction.billed event.transaction.canceledtransaction.canceled event.transaction.completedtransaction.completed event.transaction.createdtransaction.created event.transaction.paidtransaction.paid event.transaction.past_duetransaction.past_due event.transaction.payment_failedtransaction.payment_failed event.transaction.readytransaction.ready event.transaction.revisedtransaction.revised event.transaction.updatedtransaction.updated event.null for single events.2024-10-12T07:20:50.52Znull until run. Set automatically by Paddle.2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Zntfsim_01ghbkd0frb9k95cnhwd1bxpvkntfsim_.^ntfsim_[a-z\d]{26}$activeactivearchivedntfset_01gt21c5pdx9q1e4mh1xrsjjn6ntfset_.^ntfset_[a-z\d]{26}$subscription_creationsubscription_renewalsubscription_pausesubscription_resumesubscription_cancellationnull for scenarios.sub_01h04vsc0qhwtsbsxh3422wjs4^sub_[a-z\d]{26}$immediatelyimmediately.next_billing_periodimmediatelyfalsetrue) or not (false), which determines whether events occur for canceling past due transactions. If omitted, defaults to false.ctm_01grnn4zta5a1mf02jjze7y2ys^ctm_[a-z\d]{26}$add_01gm302t81w94gyjpjpqypkzkfcustomer_id.^add_[a-z\d]{26}$biz_01grrebrzaee2qj2fqqhmcyzajcustomer_id.^biz_[a-z\d]{26}$paymtd_01hkm9xwqpbbpr1ksmvg3sx3v1customer_id.^paymtd_[a-z\d]{26}$dsc_01gv5kpg05xp104ek2fmgjwttfitems or transaction_id for the discount to be applied.^dsc_[a-z\d]{26}$txn_01h04vsbhqc62t8hmd4z3b578c^txn_[a-z\d]{26}$5pri_01gsz8z1q1n00f12qt82y31smh^pri_[a-z\d]{26}$newnew.newexisting_email_matchedexisting_details_prefillednot_providednot_provided.not_providednewexisting_details_prefillednot_providednot_provided.not_providedprefilledentities.discount_id.entered_by_customerentities.discount_id.sub_01h04vsc0qhwtsbsxh3422wjs4^sub_[a-z\d]{26}$immediatelyimmediately.next_billing_periodimmediatelyfalsetrue) or not (false), which determines whether events occur for canceling past due transactions. If omitted, defaults to false.sub_01h04vsc0qhwtsbsxh3422wjs4^sub_[a-z\d]{26}$successsuccess.successrecovered_existing_payment_methodrecovered_updated_payment_methodfailedpayment_outcome is failed. If omitted, defaults to null.subscription_pausedsubscription_canceledsub_01h04vsc0qhwtsbsxh3422wjs4^sub_[a-z\d]{26}$successsuccess.successrecovered_existing_payment_methodrecovered_updated_payment_methodfailedpayment_outcome is failed. If omitted, defaults to null.subscription_pausedsubscription_canceled2024-10-12T07:20:50.52Znull until run. Set automatically by Paddle.2024-10-12T07:20:50.52Z2024-10-13T07:20:50.52Zb15ec92e-8688-40d4-a04d-f44cbec93355after parameter that marks the starting point of the next page. Always returned, even if has_more is false.999Estimated number of entities for this response.
For datasets with 100,000 or fewer matches, returns the exact count. For datasets with more than 100,000 matches, returns 100001 to indicate that more than 100,000 entities match. Returns -1 when counting is skipped or couldn't be calculated.
Use has_more and next to page through all results rather than relying on estimated_total for an exact count.
{ "data": [ { "id": "ntfsim_01j82fs5pvrdse93e1kawqy2fr", "notification_setting_id": "ntfset_01j8259dtga48jwekrv2pmk0kp", "name": "Refund or chargeback created", "type": "adjustment.created", "status": "active", "payload": null, "config": null, "last_run_at": "2024-09-18T11:55:18.261049Z", "created_at": "2024-09-18T11:55:15.547675Z", "updated_at": "2024-09-18T11:55:18.261225Z" }, { "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_cancellation": null, "subscription_creation": { "entities": { "customer_id": null, "address_id": null, "business_id": null, "payment_method_id": null, "discount_id": null, "transaction_id": null, "items": null }, "options": { "customer_simulated_as": "existing_email_matched", "business_simulated_as": "not_provided", "discount_simulated_as": "not_provided" } }, "subscription_pause": null, "subscription_renewal": null, "subscription_resume": null }, "last_run_at": null, "created_at": "2024-09-18T11:11:55.265125Z", "updated_at": "2024-09-18T11:54:18.543265Z" } ], "meta": { "pagination": { "per_page": 50, "estimated_total": 2, "next": "https://api.paddle.dev/simulations?after=ntfsim_01j55cce7pz60k2a4dfeh1c9sa", "has_more": false }, "request_id": "ad095054-41bc-4907-907d-da18310aea49" }}Paddle.com Market Ltd. 20122026
| Web Proxy Viewer | New URL | Original Page |