Skip to main content

At a glance

Credentials

Set these per environment. See Connect an integration.

Setup

  1. Create a Paddle account: Sign up for a free sandbox account at https://sandbox-login.paddle.com/signup to test against simulated data, or use your live account at 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

Tools

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.