Heading

Paragraph

PageSummary

Link

Fragment

Event types are actions that Paddle creates events for.

Event types

List of API versions that this event type supports.

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

Type of event sent by Paddle, in the format `entity.event_type`.

Event type

Overview

About

Authentication

Versioning

Paddle IDs

Data types

Custom data

Errors

Success responses

Pagination

Rate limiting

Related entities

Default scopes

Filter and sort

Lists

Delete entities

Entities

Product object

List products

Create a product

Get a product

Update a product

Products

Price object

List prices

Create a price

Get a price

Update a price

Prices

Discount object

List discounts

Create a discount

Get a discount

Update a discount

Discounts

Customer object

List customers

Create a customer

Get a customer

Update a customer

List credit balances for a customer

Customers

Address object

List addresses for a customer

Create an addresses for a customer

Get an address for a customer

Update an address for a customer

Addresses

Business object

List businesses for a customer

Create a business for a customer

Get a business for a customer

Update a business for a customer

Businesses

Transaction object

List transactions

Create a transaction

Get a transaction

Update a transaction

Preview a transaction

Get a PDF invoice for a transaction

Transactions

Subscription object

List subscriptions

Get a subscription

Preview an update to a subscription

Update a subscription

Get a transaction to update payment method

Preview a one-time charge for a subscription

Create a one-time charge for a subscription

Activate a trialing subscription

Pause a subscription

Resume a paused subscription

Cancel a subscription

Subscriptions

Adjustment object

List adjustments

Create an adjustment

Adjustments

Pricing preview object

Preview prices

Pricing preview

Report object

List reports

Create a report

Get a report

Get a CSV file for a report

Reports

Event type object

List event types

Event object

List events

Events

Notification settings object

List notification settings

Create a notification setting

Get a notification setting

Update a notification setting

Delete a notification setting

Notification settings

Notifications object

List notifications

Get a notification

Replay a notification

Notifications

Notifications logs object

List logs for a notification

Notification logs

Event types

Attributes