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

# Paddle

> Access Paddle Billing products, prices, customers, transactions, and subscriptions

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key from `PADDLE_API_KEY` is sent as the `Bearer` prefixed `Authorization` header.
* **Docs**: [https://developer.paddle.com/api-reference/about/authentication](https://developer.paddle.com/api-reference/about/authentication)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable         | Required | Description                                                                                                                                                     |
| ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PADDLE_API_KEY` | Yes      | Paddle API key (pdl\_live\_apikey\_.... for live, pdl\_sdbx\_apikey\_.... for sandbox) [Docs](https://developer.paddle.com/api-reference/about/authentication). |

## Setup

1. **Create a Paddle account**: Sign up for a free sandbox account at [https://sandbox-login.paddle.com/signup](https://sandbox-login.paddle.com/signup) to test against simulated data, or use your live account at [https://login.paddle.com](https://login.paddle.com).
2. **Create an API key**: In the Paddle dashboard, go to Paddle > Developer tools > Authentication, open the API keys tab, and select New API key. Name it, assign the permissions you need (e.g. read for products, prices, customers, transactions, subscriptions; write for products), and set an expiry (default 90 days, maximum 1 year). The key is shown only once - store it securely.
3. **Configure the environment variable**: Set PADDLE\_API\_KEY to your key. Sandbox keys start with pdl\_sdbx\_apikey\_ and live keys with pdl\_live\_apikey\_.

* Sandbox uses a separate host: replace api.paddle.com with sandbox-api.paddle.com when working with a sandbox key. Keys are environment-specific and do not work across environments.
* List endpoints return a data array plus meta pagination info; follow meta.pagination.next or pass the last ID as the after cursor.
* Transactions are capped at 30 results per page; other entities support larger pages.
* API keys expire (maximum 1 year), so rotate them before expiry to avoid outages.

Provider API reference: [https://developer.paddle.com/api-reference/overview](https://developer.paddle.com/api-reference/overview)

## Tools

| Tool               | Access | Description                                                                                         |
| ------------------ | ------ | --------------------------------------------------------------------------------------------------- |
| List Products      | Read   | List products in the Paddle catalog, optionally including their prices                              |
| List Prices        | Read   | List prices for Paddle products to find price IDs for checkouts and subscriptions                   |
| List Customers     | Read   | List or search Paddle customers to find customer IDs and contact details                            |
| List Transactions  | Read   | List Paddle transactions for revenue review, filtered by status, customer, or subscription          |
| List Subscriptions | Read   | List Paddle subscriptions to review recurring revenue, statuses, and renewal dates                  |
| Get Subscription   | Read   | Retrieve a single Paddle subscription with its items, status, and billing dates                     |
| Create Customer    | Write  | Create a new Paddle customer, e.g. before creating transactions or subscriptions for a new buyer    |
| Create Price       | Write  | Create a price for a Paddle product so it can be used in checkouts, transactions, and subscriptions |
| Create Product     | Write  | Create a new product in the Paddle catalog                                                          |

## Example prompts

* List my recent completed Paddle transactions and summarize revenue by product.
* Show me my active Paddle subscriptions and flag any that are past due or canceled.
* List my Paddle products with their prices and summarize the current catalog.