Qodex.ai

Paddle API

Paddle Billing is a complete subscription and recurring revenue management platform, designed for modern SaaS businesses. It helps you increase your revenue, retain customers, and scale your operations.

Use the Paddle API to create, read, and update information in your Paddle Billing system.

Learn more:

Qodex workspace

This is the official Qodex workspace for Paddle Billing. You'll find a collection for each supported version of the Paddle API here.

The Paddle Classic API is not part of this Qodex collection. To work with the Paddle Classic API, see: Paddle Classic API reference

Get started

You can fork a collection to create a copy that you can work with.

Click on a collection in the sidebar of the Paddle Billing workspace, then choose Create a fork from the menu to get started.

You can call your forked collection anything you like, though we recommend keeping the API version in the name to help you keep track if you work with more than one version in the future.

Update a forked collection

We update the Paddle Billing platform and Paddle API regularly with non-breaking changes. This includes new operations, fields, or query parameters that you can adopt at your own pace.

You can pull and merge updates from the parent collection in the Paddle workspace to get updates.

Click on your forked collection in the sidebar, then choose Pull changes from the menu to start updating. Review the changes, then merge.

When we introduce breaking changes, we release a new version of the API. To work with a new version of the Paddle API in Qodex, clone the collection in the Paddle Billing workspace.

Set up your environment

You'll need to add an API key to authenticate, and set the base URL for requests. There are different base URLs for sandbox and live accounts.

First, create an API key in Paddle > Developer tools > Authentication. We recommend creating a separate key for Qodex.

Then, in Qodex:

  1. Click on the environments tab on the sidebar of the Paddle Billing workspace, click Sandbox, then choose Create a fork from the menu.

  2. Add your API key to the bearerToken variable, then click Save.

  3. Check the box next to the environment to make it active.

  4. Head to the collection you forked, then set it to use the environment you just created.

If you'd like to work with the live environment in Qodex, repeat the process above for the Live template.

Send a test call

The quickest way to test your authentication is to send a request to the /event-types endpoint. This returns a list of the types of events that are included in the event stream. It returns data even if you haven't created any entities in Paddle yet.

Choose Events > List event types from your forked collection, then click Send to make a request.

If successful, Paddle responds with an array containing an object for each event type.

Create test data

The Paddle API accepts JSON for requests. You can create a customer to test.

  1. Choose Customers > Create a customer from your forked collection.

  2. Click on the body tab, then choose raw as the data type.

  3. Enter the following example, then choose Send.

{
  "name": "Sam Miller",
  "email": "sam@test.com"
}

Get help using Qodex

  • [Forking a collection]

  • [Managing environments]

  • [Specifying authorization requests]

  • [Building requests]

Get help with Paddle Billing