Order Information
User History
Prices
Coupons
Products
Licenses
Pay Links
Transactions
Plans
Subscription Users
Modifiers
Payments
One-off Charges
Webhooks

API Reference

Build subscription and billing functions integrated with your core platform

Overview

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

  • Other than the Checkout API, requests generally require authentication via parameters available in your Seller Dashboard.
  • API responses are sent as JSON in all instances.
  • Unauthenticated GET requests accept parameters as URL parameters, whereas authenticated requests accept parameters as either form data or JSON.

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
Try it out with your account details
Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.
Or try the cURL request below
curl -X POST \
     -d 'vendor_id=123' \
     -d 'vendor_auth_code=123:456abc' \
     https://vendors.paddle.com/api/2.0/product/get_products

Common API Use Cases

Testing

Try the API out in Postman

Run in Postman