K
Ask AI API reference
OverviewAbout
Addresses
Businesses
Checkout domains
Client-side tokens
Customer portal sessions
Customers
Discount groups
Event types
Events
IP addresses
Metrics
Notification logs
Notification settings
Pricing preview
Saved payment methods
Simulation run events
Simulation runs
Simulation types
Subscription history
Subscriptions
OverviewList subscriptionsGet a subscriptionUpdate a subscriptionGet a transaction to update payment methodActivate a trialing subscriptionCancel a subscriptionCreate a one-time charge for a subscriptionPause a subscriptionResume a paused subscriptionPreview an update to a subscriptionPreview a one-time charge for a subscription
Home
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 request How do I authenticate? What do error codes mean? How do I fork the Postman collection?
![[Illustration showing a browser window with a sparkle icon, connected to a user profile icon, a search icon, and a toggle control.]](https://developer.paddle.com/_astro/new-api-reference.3Ui431Zv.svg){kind=link}
Start here
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.
Browse by resource
Catalog
Define what you sell.
- Products GET POST PATCH
- Prices GET POST PATCH
- Discounts GET POST PATCH
- Discount groups GET POST PATCH
Customers
People and businesses you bill.
- Customers GET POST PATCH
- Addresses GET POST PATCH
- Businesses GET POST PATCH
- Payment methods GET DELETE
Billing
Charge customers and reconcile.
- Transactions GET POST PATCH
- Subscriptions GET POST PATCH
- Adjustments GET POST
- Pricing preview POST
- Customer portals POST
Events
Stay in sync with the lifecycle.
- Events GET
- Event types GET
- Notifications GET POST
- Notification settings GET POST PATCH DELETE
- Notification logs GET
Reporting
Pull analytics and generate reports.
Platform
Authenticate requests and look up infrastructure.
- Client-side tokens GET POST PATCH
- IP addresses GET
Webhook simulator
Test webhooks and edge cases.
- Simulations GET POST PATCH
- Simulation types GET
- Simulation runs GET POST
- Simulation run events GET POST
Privacy policy
Terms
Manage cookies
Paddle.com Market Ltd. 20122026