API Reference

Overview

Build subscription and billing functions integrated with your core platform

Paddle provides a suite of simple and flexible API endpoints to retrieve or update data on your subscription plans, products, payments, and customers.

Other than the Checkout API, requests generally require authentication via parameters available in your Seller Dashboard.

Unauthenticated GET requests accept parameters as URL parameters, whereas authenticated POST requests accept parameters as either form-data or JSON.

API responses are sent as JSON in all instances.

Quick Start

1. Set up a product in your Paddle Seller Dashboard
2. Get your authentication details
3. Try the request below to fetch all products and plans on your account

Replacing the values with your own, use the cURL request below
preparing...

Common API Use Cases

• Create a payment link to override default checkout behavior
• Update the details of an active subscription
• Fetch an array of product prices
• Get the transactions history for a user

Testing

Try the API out in Postman.

If you're trying out the API in your sandbox environment, you'll need to add a sandbox- prefix to the URL hostname for endpoints in this collection. For more information please check the Sandbox page.