List simulation types

GET /simulation-types

Returns a list of simulation types (events and scenarios) that you can choose from when creating simulations.

Response (200)

dataarrayrequired

namestringrequired

Example: subscription_creation

Type of simulation sent by Paddle. Single event simulations are in the format entity.event_type; scenario simulations are in snake_case.

labelstringrequired

Example: Subscription created from a checkout

Descriptive label for this simulation type. Typically gives more context about a scenario. Single event simulations are in the format entity.event_type.

descriptionstringrequired

Example: `subscription.created` events occur when a subscription is created.

Short description of this simulation type.

groupstringrequired

Example: Subscriptions

Group for this simulation type. Typically the entity that this event relates to.

typestringrequired

Example: single_event

Type of simulation.

Values

single_event
Paddle simulates a single event.
scenario
Paddle simulates a predefined series of events for a scenario, like all events created when a subscription renews.

eventsarrayrequired

List of events that will be sent for this simulation type.

Values

address.created
An address.created event.
address.imported
An address.imported event.
address.updated
An address.updated event.
adjustment.created
An adjustment.created event.
adjustment.updated
An adjustment.updated event.

+ Show all values

api_key.created
An api_key.created event.
api_key.expired
An api_key.expired event.
api_key.expiring
An api_key.expiring event.
api_key.revoked
An api_key.revoked event.
api_key.updated
An api_key.updated event.
api_key_exposure.created
An api_key_exposure.created event.
business.created
A business.created event.
business.imported
A business.imported event.
business.updated
A business.updated event.
client_token.created
A client_token.created event.
client_token.revoked
A client_token.revoked event.
client_token.updated
A client_token.updated event.
customer.created
A customer.created event.
customer.imported
A customer.imported event.
customer.updated
A customer.updated event.
discount.created
A discount.created event.
discount.imported
A discount.imported event.
discount.updated
A discount.updated event.
discount_group.created
A discount_group.created event.
discount_group.updated
A discount_group.updated event.
payment_method.saved
A payment_method.saved event.
payment_method.deleted
A payment_method.deleted event.
payout.created
A payout.created event.
payout.paid
A payout.paid event.
price.created
A price.created event.
price.imported
A price.imported event.
price.updated
A price.updated event.
product.created
A product.created event.
product.imported
A product.imported event.
product.updated
A product.updated event.
report.created
A report.created event.
report.updated
A report.updated event.
subscription.activated
A subscription.activated event.
subscription.canceled
A subscription.canceled event.
subscription.created
A subscription.created event.
subscription.imported
A subscription.imported event.
subscription.past_due
A subscription.past_due event.
subscription.paused
A subscription.paused event.
subscription.resumed
A subscription.resumed event.
subscription.trialing
A subscription.trialing event.
subscription.updated
A subscription.updated event.
transaction.billed
A transaction.billed event.
transaction.canceled
A transaction.canceled event.
transaction.completed
A transaction.completed event.
transaction.created
A transaction.created event.
transaction.paid
A transaction.paid event.
transaction.past_due
A transaction.past_due event.
transaction.payment_failed
A transaction.payment_failed event.
transaction.ready
A transaction.ready event.
transaction.revised
A transaction.revised event.
transaction.updated
A transaction.updated event.

metaobjectrequired

Information about this response.

request_idstringrequired

Example: b15ec92e-8688-40d4-a04d-f44cbec93355

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

Response

{
  "data": [
    {
      "name": "subscription_creation",
      "label": "Subscription created from a checkout",
      "description": "Occurs when a subscription is created.",
      "group": "Subscription",
      "type": "scenario",
      "events": [
        "transaction.created",
        "customer.created",
        "address.created",
        "transaction.updated",
        "transaction.ready",
        "transaction.updated",
        "transaction.paid",
        "subscription.created",
        "subscription.activated",
        "transaction.updated",
        "transaction.updated",
        "transaction.completed"
      ]
    },
    {
      "name": "subscription_renewal",
      "label": "Subscription renewed successfully",
      "description": "Occurs when a subscription is renewed.",
      "group": "Subscription",
      "type": "scenario",
      "events": [
        "subscription.updated",
        "transaction.created",
        "transaction.billed",
        "transaction.updated",
        "transaction.paid",
        "transaction.updated",
        "transaction.completed"
      ]
    },
    {
      "name": "subscription_pause",
      "label": "Subscription paused by customer",
      "description": "Occurs when a subscription is paused.",
      "group": "Subscription",
      "type": "scenario",
      "events": [
        "subscription.updated",
        "subscription.paused"
      ]
    },
    {
      "name": "subscription_resume",
      "label": "Subscription resumed after being paused",
      "description": "Occurs when a subscription is resumed after being paused.",
      "group": "Subscription",
      "type": "scenario",
      "events": [
        "subscription.updated",
        "subscription.resumed",
        "transaction.created",
        "transaction.billed",
        "transaction.updated",
        "transaction.paid",
        "transaction.updated",
        "transaction.completed"
      ]
    },
    {
      "name": "subscription_cancellation",
      "label": "Subscription canceled by customer",
      "description": "Occurs when a subscription is canceled.",
      "group": "Subscription",
      "type": "scenario",
      "events": [
        "subscription.updated",
        "subscription.canceled"
      ]
    },
    {
      "name": "subscription.activated",
      "label": "subscription.activated",
      "description": "Occurs when a subscription becomes active. Its status field changes to active. This means any trial period has elapsed and Paddle has successfully billed the customer.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.activated"
      ]
    },
    {
      "name": "subscription.canceled",
      "label": "subscription.canceled",
      "description": "Occurs when a subscription is canceled. Its status field changes to canceled.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.canceled"
      ]
    },
    {
      "name": "subscription.created",
      "label": "subscription.created",
      "description": "Occurs when a subscription is created. subscription.trialing or subscription.activated typically follow.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.created"
      ]
    },
    {
      "name": "subscription.past_due",
      "label": "subscription.past_due",
      "description": "Occurs when a subscription has an unpaid transaction. Its status changes to past_due.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.past_due"
      ]
    },
    {
      "name": "subscription.paused",
      "label": "subscription.paused",
      "description": "Occurs when a subscription is paused. Its status field changes to paused.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.paused"
      ]
    },
    {
      "name": "subscription.resumed",
      "label": "subscription.resumed",
      "description": "Occurs when a subscription is resumed after being paused. Its status field changes to active.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.resumed"
      ]
    },
    {
      "name": "subscription.trialing",
      "label": "subscription.trialing",
      "description": "Occurs when a subscription enters trial period.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.trialing"
      ]
    },
    {
      "name": "subscription.updated",
      "label": "subscription.updated",
      "description": "Occurs when a subscription is updated.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.updated"
      ]
    },
    {
      "name": "subscription.imported",
      "label": "subscription.imported",
      "description": "Occurs when a subscription is imported.",
      "group": "Subscription",
      "type": "single_event",
      "events": [
        "subscription.imported"
      ]
    },
    {
      "name": "address.created",
      "label": "address.created",
      "description": "Occurs when an address is created.",
      "group": "Address",
      "type": "single_event",
      "events": [
        "address.created"
      ]
    },
    {
      "name": "address.updated",
      "label": "address.updated",
      "description": "Occurs when an address is updated.",
      "group": "Address",
      "type": "single_event",
      "events": [
        "address.updated"
      ]
    },
    {
      "name": "address.imported",
      "label": "address.imported",
      "description": "Occurs when a address is imported.",
      "group": "Address",
      "type": "single_event",
      "events": [
        "address.imported"
      ]
    },
    {
      "name": "adjustment.created",
      "label": "adjustment.created",
      "description": "Occurs when an adjustment is created.",
      "group": "Adjustment",
      "type": "single_event",
      "events": [
        "adjustment.created"
      ]
    },
    {
      "name": "adjustment.updated",
      "label": "adjustment.updated",
      "description": "Occurs when an adjustment is updated, the only time an adjustment will be updated is when the status changes from pending to approved or from pending to rejected.",
      "group": "Adjustment",
      "type": "single_event",
      "events": [
        "adjustment.updated"
      ]
    },
    {
      "name": "business.created",
      "label": "business.created",
      "description": "Occurs when a business is created.",
      "group": "Business",
      "type": "single_event",
      "events": [
        "business.created"
      ]
    },
    {
      "name": "business.updated",
      "label": "business.updated",
      "description": "Occurs when a business is updated.",
      "group": "Business",
      "type": "single_event",
      "events": [
        "business.updated"
      ]
    },
    {
      "name": "business.imported",
      "label": "business.imported",
      "description": "Occurs when a business is imported.",
      "group": "Business",
      "type": "single_event",
      "events": [
        "business.imported"
      ]
    },
    {
      "name": "customer.created",
      "label": "customer.created",
      "description": "Occurs when a customer is created.",
      "group": "Customer",
      "type": "single_event",
      "events": [
        "customer.created"
      ]
    },
    {
      "name": "customer.updated",
      "label": "customer.updated",
      "description": "Occurs when a customer is updated.",
      "group": "Customer",
      "type": "single_event",
      "events": [
        "customer.updated"
      ]
    },
    {
      "name": "customer.imported",
      "label": "customer.imported",
      "description": "Occurs when a customer is imported.",
      "group": "Customer",
      "type": "single_event",
      "events": [
        "customer.imported"
      ]
    },
    {
      "name": "discount.created",
      "label": "discount.created",
      "description": "Occurs when a discount is created.",
      "group": "Discount",
      "type": "single_event",
      "events": [
        "discount.created"
      ]
    },
    {
      "name": "discount.updated",
      "label": "discount.updated",
      "description": "Occurs when a discount is updated.",
      "group": "Discount",
      "type": "single_event",
      "events": [
        "discount.updated"
      ]
    },
    {
      "name": "discount.imported",
      "label": "discount.imported",
      "description": "Occurs when a discount is imported.",
      "group": "Discount",
      "type": "single_event",
      "events": [
        "discount.imported"
      ]
    },
    {
      "name": "payout.created",
      "label": "payout.created",
      "description": "Occurs when a payout is created.",
      "group": "Payout",
      "type": "single_event",
      "events": [
        "payout.created"
      ]
    },
    {
      "name": "payout.paid",
      "label": "payout.paid",
      "description": "Occurs when a payout is paid.",
      "group": "Payout",
      "type": "single_event",
      "events": [
        "payout.paid"
      ]
    },
    {
      "name": "price.created",
      "label": "price.created",
      "description": "Occurs when a price is created.",
      "group": "Price",
      "type": "single_event",
      "events": [
        "price.created"
      ]
    },
    {
      "name": "price.updated",
      "label": "price.updated",
      "description": "Occurs when a price is updated.",
      "group": "Price",
      "type": "single_event",
      "events": [
        "price.updated"
      ]
    },
    {
      "name": "price.imported",
      "label": "price.imported",
      "description": "Occurs when a price is imported.",
      "group": "Price",
      "type": "single_event",
      "events": [
        "price.imported"
      ]
    },
    {
      "name": "product.created",
      "label": "product.created",
      "description": "Occurs when a product is created.",
      "group": "Product",
      "type": "single_event",
      "events": [
        "product.created"
      ]
    },
    {
      "name": "product.updated",
      "label": "product.updated",
      "description": "Occurs when a product is updated.",
      "group": "Product",
      "type": "single_event",
      "events": [
        "product.updated"
      ]
    },
    {
      "name": "product.imported",
      "label": "product.imported",
      "description": "Occurs when a product is imported.",
      "group": "Product",
      "type": "single_event",
      "events": [
        "product.imported"
      ]
    },
    {
      "name": "report.created",
      "label": "report.created",
      "description": "Occurs when a report is created.",
      "group": "Report",
      "type": "single_event",
      "events": [
        "report.created"
      ]
    },
    {
      "name": "report.updated",
      "label": "report.updated",
      "description": "Occurs when a report is updated.",
      "group": "Report",
      "type": "single_event",
      "events": [
        "report.updated"
      ]
    },
    {
      "name": "transaction.billed",
      "label": "transaction.billed",
      "description": "Occurs when a transaction is billed. Its status field changes to billed and billed_at is populated.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.billed"
      ]
    },
    {
      "name": "transaction.canceled",
      "label": "transaction.canceled",
      "description": "Occurs when a transaction is canceled. Its status field changes to canceled.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.canceled"
      ]
    },
    {
      "name": "transaction.completed",
      "label": "transaction.completed",
      "description": "Occurs when a transaction is completed. Its status field changes to completed.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.completed"
      ]
    },
    {
      "name": "transaction.created",
      "label": "transaction.created",
      "description": "Occurs when a transaction is created.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.created"
      ]
    },
    {
      "name": "transaction.paid",
      "label": "transaction.paid",
      "description": "Occurs when a transaction is paid. Its status field changes to paid.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.paid"
      ]
    },
    {
      "name": "transaction.past_due",
      "label": "transaction.past_due",
      "description": "Occurs when a transaction becomes past due. Its status field changes to past_due.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.past_due"
      ]
    },
    {
      "name": "transaction.payment_failed",
      "label": "transaction.payment_failed",
      "description": "Occurs when a payment fails for a transaction. The payments array is updated with details of the payment attempt.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.payment_failed"
      ]
    },
    {
      "name": "transaction.ready",
      "label": "transaction.ready",
      "description": "Occurs when a transaction is ready to be billed. Its status field changes to ready.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.ready"
      ]
    },
    {
      "name": "transaction.updated",
      "label": "transaction.updated",
      "description": "Occurs when a transaction is updated.",
      "group": "Transaction",
      "type": "single_event",
      "events": [
        "transaction.updated"
      ]
    }
  ],
  "meta": {
    "request_id": "76905a23-8206-44ca-8821-7237b26f59d1"
  }
}

List simulation types

Response (200)

Was this page helpful?