Connecting to Paddle

Using API Key Authentication

Paddle uses API key authentication. To obtain an API key:

Sign in to your Paddle account at https://vendors.paddle.com
Navigate to Developer Tools > Authentication
Click "Generate API Key"
Assign the appropriate permissions for the data you wish to access
Copy the generated key (sandbox keys begin with pdl_sdbx_apikey_; production keys begin with pdl_live_apikey_)

After obtaining your API key, set the following connection properties:

AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

APIKey: Set this to your Paddle API key.

Example Connection String

Profile=C:\profiles\Paddle.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

Connecting to Paddle

Once the authentication is configured, you can connect to Paddle and query data from any of the available tables such as Products, Customers, Subscriptions, and Transactions.

Available Tables

The Paddle API Profile provides access to the following tables:

Addresses: Returns addresses for a Paddle customer (requires CustomerId)
Adjustments: Returns Paddle adjustments. Supports filtering by action, transaction, subscription, customer, and status
Businesses: Returns businesses for a Paddle customer (requires CustomerId)
Customers: Returns Paddle customers. Use status and email filters to narrow results
DiscountGroups: Returns Paddle discount groups. Supports filtering by status
Discounts: Returns Paddle discounts
Events: Returns Paddle events. Supports filtering by event type
NotificationLogs: Returns delivery attempt logs for a Paddle notification (requires NotificationId)
Notifications: Returns Paddle notifications. Supports filtering by status and notification setting
PaymentMethods: Returns payment methods saved by a Paddle customer (requires CustomerId)
Prices: Returns Paddle prices. Filter by ProductId to list prices for a specific product
Products: Returns Paddle products. Use the status filter to list archived products
Reports: Returns Paddle reports. Supports filtering by status. Poll status until ready before downloading
Subscriptions: Returns Paddle subscriptions. Supports filtering by status, customer, address, and collection mode
Transactions: Returns Paddle transactions. Supports filtering by status, customer, subscription, and date ranges

Important Notes

Some tables require a parent identifier (e.g. CustomerId, NotificationId) to be specified as a filter.
Sandbox API keys (pdl_sdbx_apikey_) connect to the Paddle sandbox environment; production keys (pdl_live_apikey_) connect to live data.
Date fields use ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss).
Rate limiting applies - refer to Paddle API documentation for current limits.

API Documentation

For more information about the Paddle API, see the official Paddle API documentation.

Usage Examples

Products:

SELECT * FROM Products

Customers:

SELECT * FROM Customers

Subscriptions:

SELECT * FROM Subscriptions

Transactions:

SELECT * FROM Transactions

Discounts:

SELECT * FROM Discounts

Prices:

SELECT * FROM Prices

Events:

SELECT * FROM Events

Notifications:

SELECT * FROM Notifications

Reports:

SELECT * FROM Reports

DiscountGroups:

SELECT * FROM DiscountGroups

Adjustments:

SELECT * FROM Adjustments

Addresses:

SELECT * FROM Addresses WHERE CustomerId = 'ctm_xxxxxxxxxxxxxxxxxx'

Businesses:

SELECT * FROM Businesses WHERE CustomerId = 'ctm_xxxxxxxxxxxxxxxxxx'

PaymentMethods:

SELECT * FROM PaymentMethods WHERE CustomerId = 'ctm_xxxxxxxxxxxxxxxxxx'

NotificationLogs:

SELECT * FROM NotificationLogs WHERE NotificationId = 'ntf_xxxxxxxxxxxxxxxxxx'

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

Property	Description
APIKey	The API key for your Paddle account.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT