v1.2.0
54 actions · 57 events · 1 auth method
Payments
Getting Started
1
Create or Select a Project
Set up a new project or select an existing one. See Organizations & Projects.
2
Configure the Connector
Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.
Optionally, configure receiving Events for Paddle into StackOne.
Connector Profile · API Key
Use your Paddle API Key for authentication. Create API keys in Developer tools > Authentication. Keys are 69 characters…
Webhooks setup
3
Link an Account
Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:
Link Account · API Key
4
Use Actions
Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.
Actions
54 actions
Action
Description
List Addresses
Retrieve a paginated list of addresses for a customer
Get Address
Get an address for a customer by ID
Create Address
Create a new address for a customer
Update Address
Update an address for a customer
List Businesses
Retrieve a paginated list of businesses for a customer
Get Business
Retrieve a specific business for a customer
Create Business
Create a new business for a customer
Update Business
Update a business for a customer
List Customers
Retrieve a paginated list of customers
Get Customer
Get a customer by ID
Create Customer
Create a new customer
Update Customer
Update a customer
List Credit Balances
List credit balances for a customer
Generate Auth Token
Generate authentication token for a customer
List Discount Groups
Retrieve a paginated list of discount groups
Get Discount Group
Retrieve a specific discount group by ID
Create Discount Group
Create a new discount group
Update Discount Group
Update a discount group
List Discounts
Retrieve a paginated list of discounts
Get Discount
Retrieve a specific discount by ID
Create Discount
Create a new discount
Update Discount
Update a discount
List Events
Retrieve a paginated list of events from the event stream
List Event Types
Retrieve a list of all event types
List Notifications
Retrieve a paginated list of notifications from the last 90 days
Get Notification
Retrieve a specific notification
Replay Notification
Resend a delivered or failed notification
List Payment Methods
Retrieve a paginated list of payment methods for a customer
Get Payment Method
Retrieve a specific payment method for a customer
Delete Payment Method
Delete a payment method for a customer
List Prices
Retrieve a paginated list of prices
Get Price
Get a price by ID
Create Price
Create a new price
Update Price
Update a price
Preview Prices
Preview calculations for one or more prices
List Products
Retrieve a paginated list of products
Get Product
Get a product by ID
Create Product
Create a new product
Update Product
Update a product
List Subscriptions
Retrieve a paginated list of subscriptions
Get Subscription
Retrieve a specific subscription
Update Subscription
Update a subscription using its ID
Create One-Time Charge For Subscription
Create a one-time charge for a subscription
Preview One-Time Charge For Subscription
Preview a one-time charge for a subscription without billing
Pause Subscription
Pause a subscription
Resume Subscription
Resume a paused subscription
Cancel Subscription
Cancel a subscription
Activate Trialing Subscription
Activate a trialing subscription
List Transactions
Retrieve a paginated list of transactions
Create Transaction
Create a new transaction
Update Transaction
Update a transaction
Get Transaction
Retrieve a specific transaction
Get Transaction Invoice PDF
Generate and retrieve invoice PDF for a transaction
Revise Transaction
Update customer and address information for a transaction
Events
|
No tags found
57 events
Event
Description
Tags
Active Check
Acknowledges Paddle health-check pings. Returns 200 OK to confirm the webhook endpoint is reachable.
Webhooks
Address Created
Fired when a new address is created on a customer account.
CustomersAddressesWebhooks
Address Imported
Fired when an address is imported into a customer account.
CustomersAddressesWebhooks
Address Updated
Fired when an address on a customer account is updated.
CustomersAddressesWebhooks
Adjustment Created
Fired when a new adjustment (refund, credit, or chargeback) is created for a transaction.
AdjustmentsWebhooks
Adjustment Updated
Fired when an existing adjustment is updated (e.g., status changes from pending to approved).
AdjustmentsWebhooks
API Key Created
Fired when a new API key is created.
API KeysWebhooks
API Key Expired
Fired when an API key reaches its expiration date.
API KeysWebhooks
API Key Expiring
Fired shortly before an API key is due to expire, providing advance warning.
API KeysWebhooks
API Key Revoked
Fired when an API key is manually revoked before its expiration date.
API KeysWebhooks
API Key Updated
Fired when an API key’s properties (name, description, expiry) are updated.
API KeysWebhooks
API Key Exposure Created
Fired when a potential API key exposure is detected (e.g., key found in a public repository).
API KeysWebhooks
Business Created
Fired when a new business entity is created on a customer account.
CustomersBusinessesWebhooks
Business Imported
Fired when a business entity is imported into a customer account.
CustomersBusinessesWebhooks
Business Updated
Fired when a business entity on a customer account is updated.
CustomersBusinessesWebhooks
Client Token Created
Fired when a new client-side token is created.
Client TokensWebhooks
Client Token Revoked
Fired when a client-side token is revoked.
Client TokensWebhooks
Client Token Updated
Fired when a client-side token’s properties are updated.
Client TokensWebhooks
Customer Created
Fired when a new customer is created.
CustomersWebhooks
Customer Imported
Fired when a customer is imported into Paddle (e.g., via migration).
CustomersWebhooks
Customer Updated
Fired when a customer’s details are updated.
CustomersWebhooks
Discount Created
Fired when a new discount coupon or code is created.
DiscountsWebhooks
Discount Imported
Fired when a discount is imported into Paddle.
DiscountsWebhooks
Discount Updated
Fired when a discount’s properties are updated.
DiscountsWebhooks
Discount Group Created
Fired when a new discount group is created.
Discount GroupsWebhooks
Discount Group Updated
Fired when a discount group’s properties are updated.
Discount GroupsWebhooks
Payment Method Saved
Fired when a payment method is saved to a customer account.
CustomersPayment MethodsWebhooks
Payment Method Deleted
Fired when a payment method is removed from a customer account.
CustomersPayment MethodsWebhooks
Payout Created
Fired when a new payout is created for the seller account.
PayoutsWebhooks
Payout Paid
Fired when a payout is successfully sent to the seller’s bank account.
PayoutsWebhooks
Price Created
Fired when a new price is created for a product.
PricesWebhooks
Price Imported
Fired when a price is imported into Paddle.
PricesWebhooks
Price Updated
Fired when a price’s properties (amount, billing cycle, trial period) are updated.
PricesWebhooks
Product Created
Fired when a new product is created in the catalog.
ProductsWebhooks
Product Imported
Fired when a product is imported into Paddle.
ProductsWebhooks
Product Updated
Fired when a product’s properties (name, description, image, tax category) are updated.
ProductsWebhooks
Report Created
Fired when a new report is created and begins generating.
ReportsWebhooks
Report Updated
Fired when a report’s status changes (e.g., from pending to ready when the download becomes available).
ReportsWebhooks
Subscription Activated
Fired when a subscription moves from trialing or paused status to active.
SubscriptionsWebhooks
Subscription Canceled
Fired when a subscription is canceled and will not renew.
SubscriptionsWebhooks
Subscription Created
Fired when a new subscription is created for a customer.
SubscriptionsWebhooks
Subscription Imported
Fired when a subscription is imported into Paddle.
SubscriptionsWebhooks
Subscription Past Due
Fired when a subscription payment fails and the subscription enters past due status.
SubscriptionsWebhooks
Subscription Paused
Fired when a subscription is paused and billing is temporarily suspended.
SubscriptionsWebhooks
Subscription Resumed
Fired when a paused subscription is resumed and billing restarts.
SubscriptionsWebhooks
Subscription Trialing
Fired when a subscription enters a trial period.
SubscriptionsWebhooks
Subscription Updated
Fired when a subscription’s properties (plan, quantity, billing cycle, scheduled changes) are updated.
SubscriptionsWebhooks
Transaction Billed
Fired when a transaction is billed and an invoice is issued to the customer.
TransactionsWebhooks
Transaction Canceled
Fired when a transaction is canceled before it is completed.
TransactionsWebhooks
Transaction Completed
Fired when a transaction is fully completed and payment is confirmed.
TransactionsWebhooks
Transaction Created
Fired when a new transaction is created.
TransactionsWebhooks
Transaction Paid
Fired when payment is successfully collected for a transaction.
TransactionsWebhooks
Transaction Past Due
Fired when a transaction passes its due date without a successful payment.
TransactionsWebhooks
Transaction Payment Failed
Fired when a payment attempt for a transaction fails.
TransactionsWebhooks
Transaction Ready
Fired when a transaction is ready for payment (all required details are present).
TransactionsWebhooks
Transaction Revised
Fired when a completed transaction is revised (e.g., a credit note or corrective invoice is issued).
TransactionsWebhooks
Transaction Updated
Fired when a transaction’s details (items, customer, billing address) are updated.
TransactionsWebhooks