GET
/event-types Returns a list of event types.
The response is not paginated.
Response (200)
dataarrayrequired
namestringrequired
Type of event sent by Paddle, in the format
entity.event_type.Values
address.createdAnaddress.createdevent.address.importedAnaddress.importedevent.address.updatedAnaddress.updatedevent.adjustment.createdAnadjustment.createdevent.adjustment.updatedAnadjustment.updatedevent.
+ Show all values− Hide values
api_key.createdAnapi_key.createdevent.api_key.expiredAnapi_key.expiredevent.api_key.expiringAnapi_key.expiringevent.api_key.revokedAnapi_key.revokedevent.api_key.updatedAnapi_key.updatedevent.api_key_exposure.createdAnapi_key_exposure.createdevent.business.createdAbusiness.createdevent.business.importedAbusiness.importedevent.business.updatedAbusiness.updatedevent.client_token.createdAclient_token.createdevent.client_token.revokedAclient_token.revokedevent.client_token.updatedAclient_token.updatedevent.customer.createdAcustomer.createdevent.customer.importedAcustomer.importedevent.customer.updatedAcustomer.updatedevent.discount.createdAdiscount.createdevent.discount.importedAdiscount.importedevent.discount.updatedAdiscount.updatedevent.discount_group.createdAdiscount_group.createdevent.discount_group.updatedAdiscount_group.updatedevent.payment_method.savedApayment_method.savedevent.payment_method.deletedApayment_method.deletedevent.payout.createdApayout.createdevent.payout.paidApayout.paidevent.price.createdAprice.createdevent.price.importedAprice.importedevent.price.updatedAprice.updatedevent.product.createdAproduct.createdevent.product.importedAproduct.importedevent.product.updatedAproduct.updatedevent.report.createdAreport.createdevent.report.updatedAreport.updatedevent.subscription.activatedAsubscription.activatedevent.subscription.canceledAsubscription.canceledevent.subscription.createdAsubscription.createdevent.subscription.importedAsubscription.importedevent.subscription.past_dueAsubscription.past_dueevent.subscription.pausedAsubscription.pausedevent.subscription.resumedAsubscription.resumedevent.subscription.trialingAsubscription.trialingevent.subscription.updatedAsubscription.updatedevent.transaction.billedAtransaction.billedevent.transaction.canceledAtransaction.canceledevent.transaction.completedAtransaction.completedevent.transaction.createdAtransaction.createdevent.transaction.paidAtransaction.paidevent.transaction.past_dueAtransaction.past_dueevent.transaction.payment_failedAtransaction.payment_failedevent.transaction.readyAtransaction.readyevent.transaction.revisedAtransaction.revisedevent.transaction.updatedAtransaction.updatedevent.
descriptionstringrequired
Example:
The subscription.created alert is fired when a new subscription is created.Short description of this event type.
groupstringrequired
Example:
SubscriptionsGroup for this event type. Typically the entity that this event relates to.
available_versionsarrayrequired
List of API versions that this event type supports.
metaobjectrequired
Information about this response.
request_idstringrequired
Example:
b15ec92e-8688-40d4-a04d-f44cbec93355Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.
{ "data": [ { "name": "transaction.billed", "description": "Occurs when a transaction is billed. Its status field changes to billed and billed_at is populated.", "group": "Transaction", "available_versions": [ 1 ] }, { "name": "transaction.canceled", "description": "Occurs when a transaction is canceled. Its status field changes to canceled.", "group": "Transaction", "available_versions": [ 1 ] }, { "name": "transaction.completed", "description": "Occurs when a transaction is completed. Its status field changes to completed.", "group": "Transaction", "available_versions": [ 1 ] }, { "name": "transaction.created", "description": "Occurs when a transaction is created.", "group": "Transaction", "available_versions": [ 1 ] }, { "name": "transaction.paid", "description": "Occurs when a transaction is paid. Its status field changes to paid.", "group": "Transaction", "available_versions": [ 1 ] }, { "name": "transaction.past_due", "description": "Occurs when a transaction becomes past due. Its status field changes to past_due.", "group": "Transaction", "available_versions": [ 1 ] }, { "name": "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", "available_versions": [ 1 ] }, { "name": "transaction.ready", "description": "Occurs when a transaction is ready to be billed. Its status field changes to ready.", "group": "Transaction", "available_versions": [ 1 ] }, { "name": "transaction.updated", "description": "Occurs when a transaction is updated.", "group": "Transaction", "available_versions": [ 1 ] }, { "name": "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", "available_versions": [ 1 ] }, { "name": "subscription.canceled", "description": "Occurs when a subscription is canceled. Its status field changes to canceled.", "group": "Subscription", "available_versions": [ 1 ] }, { "name": "subscription.created", "description": "Occurs when a subscription is created. subscription.trialing or subscription.activated typically follow.", "group": "Subscription", "available_versions": [ 1 ] }, { "name": "subscription.imported", "description": "Occurs when a subscription is imported.", "group": "Subscription", "available_versions": [ 1 ] }, { "name": "subscription.past_due", "description": "Occurs when a subscription has an unpaid transaction. Its status changes to past_due.", "group": "Subscription", "available_versions": [ 1 ] }, { "name": "subscription.paused", "description": "Occurs when a subscription is paused. Its status field changes to paused.", "group": "Subscription", "available_versions": [ 1 ] }, { "name": "subscription.resumed", "description": "Occurs when a subscription is resumed after being paused. Its status field changes to active.", "group": "Subscription", "available_versions": [ 1 ] }, { "name": "subscription.trialing", "description": "Occurs when a subscription enters trial period.", "group": "Subscription", "available_versions": [ 1 ] }, { "name": "subscription.updated", "description": "Occurs when a subscription is updated.", "group": "Subscription", "available_versions": [ 1 ] }, { "name": "product.created", "description": "Occurs when a product is created.", "group": "Product", "available_versions": [ 1 ] }, { "name": "product.imported", "description": "Occurs when a product is imported.", "group": "Product", "available_versions": [ 1 ] }, { "name": "product.updated", "description": "Occurs when a product is updated.", "group": "Product", "available_versions": [ 1 ] }, { "name": "price.created", "description": "Occurs when a price is created.", "group": "Price", "available_versions": [ 1 ] }, { "name": "price.imported", "description": "Occurs when a price is imported.", "group": "Price", "available_versions": [ 1 ] }, { "name": "price.updated", "description": "Occurs when a price is updated.", "group": "Price", "available_versions": [ 1 ] }, { "name": "customer.created", "description": "Occurs when a customer is created.", "group": "Customer", "available_versions": [ 1 ] }, { "name": "customer.imported", "description": "Occurs when a customer is imported.", "group": "Customer", "available_versions": [ 1 ] }, { "name": "customer.updated", "description": "Occurs when a customer is updated.", "group": "Customer", "available_versions": [ 1 ] }, { "name": "address.created", "description": "Occurs when an address is created.", "group": "Address", "available_versions": [ 1 ] }, { "name": "address.imported", "description": "Occurs when a address is imported.", "group": "Address", "available_versions": [ 1 ] }, { "name": "address.updated", "description": "Occurs when an address is updated.", "group": "Address", "available_versions": [ 1 ] }, { "name": "business.created", "description": "Occurs when a business is created.", "group": "Business", "available_versions": [ 1 ] }, { "name": "business.imported", "description": "Occurs when a business is imported.", "group": "Business", "available_versions": [ 1 ] }, { "name": "business.updated", "description": "Occurs when a business is updated.", "group": "Business", "available_versions": [ 1 ] }, { "name": "adjustment.created", "description": "Occurs when an adjustment is created.", "group": "Adjustment", "available_versions": [ 1 ] }, { "name": "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", "available_versions": [ 1 ] }, { "name": "payout.created", "description": "Occurs when a payout is created.", "group": "Payout", "available_versions": [ 1 ] }, { "name": "payout.paid", "description": "Occurs when a payout is paid.", "group": "Payout", "available_versions": [ 1 ] }, { "name": "discount.created", "description": "Occurs when a discount is created.", "group": "Discount", "available_versions": [ 1 ] }, { "name": "discount.imported", "description": "Occurs when a discount is imported.", "group": "Discount", "available_versions": [ 1 ] }, { "name": "discount.updated", "description": "Occurs when a discount is updated.", "group": "Discount", "available_versions": [ 1 ] }, { "name": "report.created", "description": "Occurs when a report is created.", "group": "Report", "available_versions": [ 1 ] }, { "name": "report.updated", "description": "Occurs when a report is updated.", "group": "Report", "available_versions": [ 1 ] } ], "meta": { "request_id": "364194bd-2f30-4cfb-8190-ce5a774efa0a" }}