> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Paddle

> How to set up the Paddle connector, plus the actions and events that are available.

![Paddle](https://stackone-logos.com/api/paddle/filled/svg)

v1.3.0[See changelog](https://docs.stackone.com/connectors/paddle/changelog.md)

[54 actions](#actions) · [57 events](#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](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/paddle/guides/connector-profile/api-key.md)
>
> Use your Paddle API Key for authentication. Create API keys in Developer tools > Authentication. Keys are 69 characters...

Optionally, configure receiving Events for Paddle into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/paddle/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/paddle/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

54 actions

ActionDescription

List Addresses`paddle_list_addresses`

Retrieve a paginated list of addresses for a customer

Get Address`paddle_get_address`

Get an address for a customer by ID

Create Address`paddle_create_address`

Create a new address for a customer

Update Address`paddle_update_address`

Update an address for a customer

List Businesses`paddle_list_businesses`

Retrieve a paginated list of businesses for a customer

Get Business`paddle_get_business`

Retrieve a specific business for a customer

Create Business`paddle_create_business`

Create a new business for a customer

Update Business`paddle_update_business`

Update a business for a customer

List Customers`paddle_list_customers`

Retrieve a paginated list of customers

Get Customer`paddle_get_customer`

Get a customer by ID

Create Customer`paddle_create_customer`

Create a new customer

Update Customer`paddle_update_customer`

Update a customer

List Credit Balances`paddle_list_credit_balances`

List credit balances for a customer

Generate Auth Token`paddle_generate_customer_authentication_token`

Generate authentication token for a customer

List Discount Groups`paddle_list_discount_groups`

Retrieve a paginated list of discount groups

Get Discount Group`paddle_get_discount_group`

Retrieve a specific discount group by ID

Create Discount Group`paddle_create_discount_group`

Create a new discount group

Update Discount Group`paddle_update_discount_group`

Update a discount group

List Discounts`paddle_list_discounts`

Retrieve a paginated list of discounts

Get Discount`paddle_get_discount`

Retrieve a specific discount by ID

Create Discount`paddle_create_discount`

Create a new discount

Update Discount`paddle_update_discount`

Update a discount

List Events`paddle_list_events`

Retrieve a paginated list of events from the event stream

List Event Types`paddle_list_event_types`

Retrieve a list of all event types

List Notifications`paddle_list_notifications`

Retrieve a paginated list of notifications from the last 90 days

Get Notification`paddle_get_notification`

Retrieve a specific notification

Replay Notification`paddle_replay_notification`

Resend a delivered or failed notification

List Payment Methods`paddle_list_customer_payment_methods`

Retrieve a paginated list of payment methods for a customer

Get Payment Method`paddle_get_customer_payment_method`

Retrieve a specific payment method for a customer

Delete Payment Method`paddle_delete_customer_payment_method`

Delete a payment method for a customer

List Prices`paddle_list_prices`

Retrieve a paginated list of prices

Get Price`paddle_get_price`

Get a price by ID

Create Price`paddle_create_price`

Create a new price

Update Price`paddle_update_price`

Update a price

Preview Prices`paddle_preview_prices`

Preview calculations for one or more prices

List Products`paddle_list_products`

Retrieve a paginated list of products

Get Product`paddle_get_product`

Get a product by ID

Create Product`paddle_create_product`

Create a new product

Update Product`paddle_update_product`

Update a product

List Subscriptions`paddle_list_subscriptions`

Retrieve a paginated list of subscriptions

Get Subscription`paddle_get_subscription`

Retrieve a specific subscription

Update Subscription`paddle_update_subscription`

Update a subscription using its ID

Create One-Time Charge For Subscription`paddle_create_subscription_charge`

Create a one-time charge for a subscription

Preview One-Time Charge For Subscription`paddle_preview_subscription_charge`

Preview a one-time charge for a subscription without billing

Pause Subscription`paddle_pause_subscription`

Pause a subscription

Resume Subscription`paddle_resume_subscription`

Resume a paused subscription

Cancel Subscription`paddle_cancel_subscription`

Cancel a subscription

Activate Trialing Subscription`paddle_activate_subscription`

Activate a trialing subscription

List Transactions`paddle_list_transactions`

Retrieve a paginated list of transactions

Create Transaction`paddle_create_transaction`

Create a new transaction

Update Transaction`paddle_update_transaction`

Update a transaction

Get Transaction`paddle_get_transaction`

Retrieve a specific transaction

Get Transaction Invoice PDF`paddle_get_transaction_invoice`

Generate and retrieve invoice PDF for a transaction

Revise Transaction`paddle_revise_transaction`

Update customer and address information for a transaction

## Events

Tags

Select all
|
Clear

API Keys

Addresses

Adjustments

Businesses

Client Tokens

Customers

Discount Groups

Discounts

Payment Methods

Payouts

Prices

Products

Reports

Subscriptions

Transactions

Webhooks

No tags found

57 events

EventDescriptionTags

Active Check`paddle_webhook_active_check`

Acknowledges Paddle health-check pings. Returns 200 OK to confirm the webhook endpoint is reachable.

Webhooks

Address Created`paddle_webhook_address_created`

Fired when a new address is created on a customer account.

CustomersAddressesWebhooks

Address Imported`paddle_webhook_address_imported`

Fired when an address is imported into a customer account.

CustomersAddressesWebhooks

Address Updated`paddle_webhook_address_updated`

Fired when an address on a customer account is updated.

CustomersAddressesWebhooks

Adjustment Created`paddle_webhook_adjustment_created`

Fired when a new adjustment (refund, credit, or chargeback) is created for a transaction.

AdjustmentsWebhooks

Adjustment Updated`paddle_webhook_adjustment_updated`

Fired when an existing adjustment is updated (e.g., status changes from pending to approved).

AdjustmentsWebhooks

API Key Created`paddle_webhook_api_key_created`

Fired when a new API key is created.

API KeysWebhooks

API Key Expired`paddle_webhook_api_key_expired`

Fired when an API key reaches its expiration date.

API KeysWebhooks

API Key Expiring`paddle_webhook_api_key_expiring`

Fired shortly before an API key is due to expire, providing advance warning.

API KeysWebhooks

API Key Revoked`paddle_webhook_api_key_revoked`

Fired when an API key is manually revoked before its expiration date.

API KeysWebhooks

API Key Updated`paddle_webhook_api_key_updated`

Fired when an API key's properties (name, description, expiry) are updated.

API KeysWebhooks

API Key Exposure Created`paddle_webhook_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`paddle_webhook_business_created`

Fired when a new business entity is created on a customer account.

CustomersBusinessesWebhooks

Business Imported`paddle_webhook_business_imported`

Fired when a business entity is imported into a customer account.

CustomersBusinessesWebhooks

Business Updated`paddle_webhook_business_updated`

Fired when a business entity on a customer account is updated.

CustomersBusinessesWebhooks

Client Token Created`paddle_webhook_client_token_created`

Fired when a new client-side token is created.

Client TokensWebhooks

Client Token Revoked`paddle_webhook_client_token_revoked`

Fired when a client-side token is revoked.

Client TokensWebhooks

Client Token Updated`paddle_webhook_client_token_updated`

Fired when a client-side token's properties are updated.

Client TokensWebhooks

Customer Created`paddle_webhook_customer_created`

Fired when a new customer is created.

CustomersWebhooks

Customer Imported`paddle_webhook_customer_imported`

Fired when a customer is imported into Paddle (e.g., via migration).

CustomersWebhooks

Customer Updated`paddle_webhook_customer_updated`

Fired when a customer's details are updated.

CustomersWebhooks

Discount Created`paddle_webhook_discount_created`

Fired when a new discount coupon or code is created.

DiscountsWebhooks

Discount Imported`paddle_webhook_discount_imported`

Fired when a discount is imported into Paddle.

DiscountsWebhooks

Discount Updated`paddle_webhook_discount_updated`

Fired when a discount's properties are updated.

DiscountsWebhooks

Discount Group Created`paddle_webhook_discount_group_created`

Fired when a new discount group is created.

Discount GroupsWebhooks

Discount Group Updated`paddle_webhook_discount_group_updated`

Fired when a discount group's properties are updated.

Discount GroupsWebhooks

Payment Method Saved`paddle_webhook_payment_method_saved`

Fired when a payment method is saved to a customer account.

CustomersPayment MethodsWebhooks

Payment Method Deleted`paddle_webhook_payment_method_deleted`

Fired when a payment method is removed from a customer account.

CustomersPayment MethodsWebhooks

Payout Created`paddle_webhook_payout_created`

Fired when a new payout is created for the seller account.

PayoutsWebhooks

Payout Paid`paddle_webhook_payout_paid`

Fired when a payout is successfully sent to the seller's bank account.

PayoutsWebhooks

Price Created`paddle_webhook_price_created`

Fired when a new price is created for a product.

PricesWebhooks

Price Imported`paddle_webhook_price_imported`

Fired when a price is imported into Paddle.

PricesWebhooks

Price Updated`paddle_webhook_price_updated`

Fired when a price's properties (amount, billing cycle, trial period) are updated.

PricesWebhooks

Product Created`paddle_webhook_product_created`

Fired when a new product is created in the catalog.

ProductsWebhooks

Product Imported`paddle_webhook_product_imported`

Fired when a product is imported into Paddle.

ProductsWebhooks

Product Updated`paddle_webhook_product_updated`

Fired when a product's properties (name, description, image, tax category) are updated.

ProductsWebhooks

Report Created`paddle_webhook_report_created`

Fired when a new report is created and begins generating.

ReportsWebhooks

Report Updated`paddle_webhook_report_updated`

Fired when a report's status changes (e.g., from pending to ready when the download becomes available).

ReportsWebhooks

Subscription Activated`paddle_webhook_subscription_activated`

Fired when a subscription moves from trialing or paused status to active.

SubscriptionsWebhooks

Subscription Canceled`paddle_webhook_subscription_canceled`

Fired when a subscription is canceled and will not renew.

SubscriptionsWebhooks

Subscription Created`paddle_webhook_subscription_created`

Fired when a new subscription is created for a customer.

SubscriptionsWebhooks

Subscription Imported`paddle_webhook_subscription_imported`

Fired when a subscription is imported into Paddle.

SubscriptionsWebhooks

Subscription Past Due`paddle_webhook_subscription_past_due`

Fired when a subscription payment fails and the subscription enters past due status.

SubscriptionsWebhooks

Subscription Paused`paddle_webhook_subscription_paused`

Fired when a subscription is paused and billing is temporarily suspended.

SubscriptionsWebhooks

Subscription Resumed`paddle_webhook_subscription_resumed`

Fired when a paused subscription is resumed and billing restarts.

SubscriptionsWebhooks

Subscription Trialing`paddle_webhook_subscription_trialing`

Fired when a subscription enters a trial period.

SubscriptionsWebhooks

Subscription Updated`paddle_webhook_subscription_updated`

Fired when a subscription's properties (plan, quantity, billing cycle, scheduled changes) are updated.

SubscriptionsWebhooks

Transaction Billed`paddle_webhook_transaction_billed`

Fired when a transaction is billed and an invoice is issued to the customer.

TransactionsWebhooks

Transaction Canceled`paddle_webhook_transaction_canceled`

Fired when a transaction is canceled before it is completed.

TransactionsWebhooks

Transaction Completed`paddle_webhook_transaction_completed`

Fired when a transaction is fully completed and payment is confirmed.

TransactionsWebhooks

Transaction Created`paddle_webhook_transaction_created`

Fired when a new transaction is created.

TransactionsWebhooks

Transaction Paid`paddle_webhook_transaction_paid`

Fired when payment is successfully collected for a transaction.

TransactionsWebhooks

Transaction Past Due`paddle_webhook_transaction_past_due`

Fired when a transaction passes its due date without a successful payment.

TransactionsWebhooks

Transaction Payment Failed`paddle_webhook_transaction_payment_failed`

Fired when a payment attempt for a transaction fails.

TransactionsWebhooks

Transaction Ready`paddle_webhook_transaction_ready`

Fired when a transaction is ready for payment (all required details are present).

TransactionsWebhooks

Transaction Revised`paddle_webhook_transaction_revised`

Fired when a completed transaction is revised (e.g., a credit note or corrective invoice is issued).

TransactionsWebhooks

Transaction Updated`paddle_webhook_transaction_updated`

Fired when a transaction's details (items, customer, billing address) are updated.

TransactionsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.