Catalog
Define what you sell.
- ProductsGETPOSTPATCH
- PricesGETPOSTPATCH
- DiscountsGETPOSTPATCH
- Discount groupsGETPOSTPATCH
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
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
Customers
People and businesses you bill.
- CustomersGETPOSTPATCH
- AddressesGETPOSTPATCH
- BusinessesGETPOSTPATCH
- Payment methodsGETDELETE
- Customer portalsPOST
Billing
Charge customers and reconcile.
- TransactionsGETPOSTPATCH
- SubscriptionsGETPOSTPATCH
- Subscription historyGET
- AdjustmentsGETPOST
- Pricing previewPOST
Events
Stay in sync with the lifecycle.
- EventsGET
- Event typesGET
- NotificationsGETPOST
- Notification settingsGETPOSTPATCHDELETE
- Notification logsGET
Account
Check and configure the account you're authenticated as.
- AccountGETPATCH
- SettingsGETPATCH
- Checkout domainsGETPOSTDELETE
- VerificationsGET
- API rootGET
Platform
Authenticate Paddle.js and look up Paddle platform data.
- Client-side tokensGETPOSTPATCH
- CountriesGET
- CurrenciesGET
- IP addressesGET
Webhook simulator
Test webhooks and edge cases.
- SimulationsGETPOSTPATCH
- Simulation typesGET
- Simulation runsGETPOST
- Simulation run eventsGETPOST
Reporting
Pull analytics and generate reports.