For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Docs

OpenAPI spec

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

AI summary

Use Paddle's OpenAPI 3.1 specification to generate client libraries, drive editor autocomplete, or import the API into tools like Scalar, Redocly, or Stoplight Studio. The spec lives at github.com/PaddleHQ/paddle-openapi.

  • • Clone the repo and pin to a tag for reproducible builds, fork it to extend the spec, or download openapi.yaml directly from main.
  • • Some codegen tools don't fully support OpenAPI 3.1 and may be incompatible with the Paddle spec — see issue #5 in the paddle-openapi repo for details.
  • • The Paddle docs MCP server is already trained on the OpenAPI spec, so AI agents can work against it without you fetching the spec from GitHub manually.

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

To get started, fork the Paddle OpenAPI spec from GitHub:

Fork the Paddle OpenAPI spec from GitHub

The spec is available at github.com/PaddleHQ/paddle-openapi. If you want, you can also:

  • Clone the repository and pin to a tag for reproducible builds.
  • 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.

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 is trained on the OpenAPI spec, as well as the rest of the Paddle documentation.

Next steps

  • Browse the API reference 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.

Was this page helpful?