API reference
Use the Paddle API to create, read, and update information in your Paddle system, and integrate Paddle into your app.
Make your first requestFeatured
Quickstart
Everything you need to make your first call to the Paddle API in a few minutes.
Authentication
Learn how to get an API key and authenticate your requests.
Permissions
Give your key the required permissions to access the API.
Pagination
Understand how to work with paginated responses
Errors
Common error codes, error response shape, and how to handle errors.
Related entities
Use the include parameter to fetch related entities in a single request.
All docs
About
Addresses
Businesses
Client-side tokens
Customer portal sessions
Customers
Discount groups
Event types
Events
IP addresses
Metrics
Notification logs
Notification settings
Notifications
Pricing preview
Saved payment methods
Simulation run events
Simulation runs
Simulation types
Simulations
Subscriptions
- Overview
- List subscriptions
- Get a subscription
- Update a subscription
- Get a transaction to update payment method
- Activate a trialing subscription
- Cancel a subscription
- Create a one-time charge for a subscription
- Pause a subscription
- Resume a paused subscription
- Preview an update to a subscription
- Preview a one-time charge for a subscription