Getting Started

Overview

Build a Paddle Checkout in 10 Minutes

Create a One-Time Product

Create a Subscription Plan

Sandbox

master

It’s super quick to get a Paddle checkout up and running on your website. Follow the steps below to sign up to Paddle, create a product on your dashboard, import the Paddle JavaScript library and open the overlay checkout on your own store page.

#### Generate a link with custom attributes set for a one-time or subscription checkout

## Overview
Custom checkouts can be based on an existing product or subscription plan (in which case they will inherit certain properties of that product - unless you override them) or can be completely custom, and not based on any existing product.

The API will return a link to the checkout that you can pass into Paddle.js using the `override` parameter. This can be done either with a Paddle checkout button:
```
<a href="#!" class="paddle_button" data-override="https://checkout.paddle.com/checkout/custom/abc123...">Buy Now!</a>
```
or as a Javascript call like below:
```
Paddle.Checkout.open({
	override: 'https://checkout.paddle.com/checkout/custom/abc123...'
});
```

## Price Overrides

Price overrides are passed as an array of strings specifying the override price with the currency, joined by a colon. For example:

```
"prices": [
	"USD:19.99",
	"EUR:15.99"
]
```

**Note:** to use the HTTP tester and code generator tool below, pass in each array value on a separate line, for example: `prices[0]:"USD:19.99"`, `prices[1]:"EUR:15.99"` and so on.

Product API

#### Generate a link with custom attributes set for a one-time or subscription checkout

## Overview
Custom checkouts can be based on an existing product or subscription plan (in which case they will inherit certain properties of that product - un...

Generate Pay Link

API Reference

APIs

Checkout API

Subscription API

Alert API

Build subscription and billing functions integrated with your core platform

Paddle Sandbox is completely separate from the Paddle Production environment. This means products/plans and dashboard settings will need to be configured independently in each environment.

Webhook Reference

Security

Verifying Webhooks

Order Fulfillment

Subscription Alerts

One-off Purchase Alerts

Risk & Dispute Alerts

Payout Alerts

Audience Alerts

Manual Invoicing Alerts

Our webhooks make it simple to receive data and events from Paddle, and for your systems to communicate data back.