> For the complete documentation index, see [llms.txt](https://developer.paddle.com/llms.txt).

# OpenAPI spec

Download the Paddle OpenAPI specification to generate client libraries, power editor tooling, or import into API exploration tools.

---

Paddle publishes an OpenAPI 3.1 specification for the Paddle Billing API. Use it to generate client libraries, drive editor autocomplete, or explore the API in tools like Scalar, Redocly, or Stoplight Studio.

## Get the spec

The spec lives at [github.com/PaddleHQ/paddle-openapi](https://github.com/PaddleHQ/paddle-openapi). You can:

- Clone the repository and pin to a tag for reproducible builds.
- Fork the repository to build on the spec, then sync to get the latest changes.
- Download the latest `openapi.yaml` directly from the `main` branch.

## When to use

- **Codegen**
  Generate a client in a language Paddle doesn't ship an SDK for.
- **Editor tooling**
  Point tools like IntelliJ HTTP Client, REST Client for VS Code, or Jetbrains HTTP Client at the spec for inline autocomplete and validation.
- **Import into a local viewer**  
  Explore the API in Scalar, Redocly, or Stoplight Studio.
- **Contract testing**  
  Validate that a Paddle-facing integration matches the schema the API promises.

{% callout type="warning" %}
Some codegen tools don't fully support OpenAPI 3.1, so may be incompatible with the Paddle OpenAPI spec. See [issue #5 on GitHub for more details](https://github.com/PaddleHQ/paddle-openapi/issues/5).
{% /callout %}

## Use an AI agent to work with the spec

You don't need to get the spec from GitHub when using the docs MCP server. The [docs MCP server](https://developer.paddle.com/sdks/ai/docs-mcp.md) is trained on the OpenAPI spec, as well as the rest of the Paddle documentation.

## Next steps

- Browse the [API reference](https://developer.paddle.com/api-reference/overview.md) for every resource and operation the SDK exposes.
- Check the developer changelog to see what's changed in the API.
- Grab the Postman collection instead to explore the API in a more visual way.