API Reference

Overview

APIs

Checkout API

Product API

Subscription API

Alert API

Getting Started

Build a Paddle Checkout in 10 Minutes

Create a One-Time Product

Create a Subscription Plan

Sandbox

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.

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.

#### List all paid and upcoming (unpaid) payments

**Example Request**
```
curl -X POST -d 'vendor_id=1234567' \
             -d 'vendor_auth_code=123456abc...' \
             -d 'subscription_id=12345' \
             -d 'from=2017-10-29' \
             -d 'to=2017-11-20' \
https://vendors.paddle.com/api/2.0/subscription/payments
```

#### List all paid and upcoming (unpaid) payments

**Example Request**
```
curl -X POST -d 'vendor_id=1234567' \
             -d 'vendor_auth_code=123456abc...' \
             -d 'subscription_id=12345' \
             -d 'from=2017-10-29' \
      ...

List Payments

Paddle Reference

Paddle.JS

Payment Methods

Platform Parameters

SDKs

With subscription API and Webhook/ Event calls, we send a status field that indicates the current subscription status of a user. Below you’ll find a reference of these possible statuses and how to deal with each of them.

Subscription Status Reference

Upon your checkout being completed successfully, or being closed/abandoned, you may wish to take additional actions, for example loading a Thank You page or showing a message to the user.