This repo contains an OpenAPI description for the Paddle API.
We use OpenAPI 3.1.
Paddle Billing is the developer-first merchant of record. We take care of payments, tax, subscriptions, and metrics with one unified API that does it all.
Use the Paddle API to create, read, and update information in your Paddle Billing system.
Important
The Paddle Classic API is not part of this repository. To work with the Paddle Classic API, see: Paddle Classic API reference
OpenAPI is a programming language-agnostic way of describing the structure and syntax of APIs. It allows humans and computers to understand how an API works. It's often used for working programmatically with an API.
The v1 directory contains an OpenAPI specification file for each supported version of the Paddle API.
We recommend that you fork this repo, rather than downloading OpenAPI files directly. This means you can get the latest changes using git in the future.
We use some vendor extensions for concepts that are harder to express with OpenAPI components.
| Extension | Type | Description |
|---|---|---|
x-enum-descriptions |
object | Provides information about enums, including a description and whether they're read-only. |
x-included |
boolean | Used to mark entities that are only included in a response when the include query parameter is used. |
We previously used some vendor extensions that are no longer included:
x-tagsto categorize schemas.x-stoplightto mark entities with stable IDs for working with Stoplight Studio.
Postman is platform for working with and testing APIs.
You can fork our Postman collection to see all operations available in the Paddle API and quickly make requests. It's a great way to explore the API if you're new to Paddle or want to test newly released functionality.
The OpenAPI spec is automatically generated and added to this repo when we release changes to the Paddle API. It's integrated with internal developer tooling at Paddle. For this reason, we don't accept contributions.
If you've spotted a problem with the OpenAPI spec, open an issue.