Get started

master

Working with the Paddle sandbox

The Paddle sandbox is a test environment where you can experiment with your integration without affecting your live environment - the two are completely separate.

Paddle Reference

Paddle.JS

Payment Methods

Platform Parameters

SDKs

The following countries are supported in the Paddle checkout and APIs:

Supported Countries

Guides

How Tos

Checkout

Pricing

Subscriptions

Track and Report

Inline Checkout

Implementing Paddle for the first time? Try our Connect a Paddle Checkout guide instead.

For example, you can collect a buyer’s email address as part of an earlier user flow and pass the value to the checkout so there is no need for the buyer to enter it a second time:

Pass parameters to the Checkout

Paddle supports cards on the most frequently used payment networks, allowing customers from around the world to pay using cards available to them.

Cards

As a part of the Paddle.Setup() call, you can pass an eventCallback parameter. This function is called for every Paddle checkout event, allowing you trigger behaviors based on user interactions with Paddle.

Checkout Events

API Reference

Overview

APIs

Checkout API

Product API

Subscription API

Alert API

#### Make an immediate one-off charge on top of an existing user subscription

This feature is useful for scenarios where buyers need to purchase add-ons on top of a recurring plan.

For example, Charges API provides you with the flexibility to charge buyers, with existing subscriptions, right away for one-off top-ups, rather than waiting for the end of their current billing cycle.

**Example Request**
```
curl -X POST -d 'vendor_id=1234567' \
             -d 'vendor_auth_code=123456abc...' \
             -d 'amount=25.00' \
             -d 'charge_name=100 additional credits' \
https://vendors.paddle.com/api/2.0/subscription/123456/charge
```

## Usage Notes 
* All one-off charges via the API will be made in full i.e. no prorated credits, no price modifiers, and no coupon discounts
* The buyer will be invoiced and charged immediately
* Charges are independent of the existing billing cycle i.e. they do not affect any existing due payments or future invoices
* There is no built-in dunning for the Charges API, so you will need to manage error handling and retries on your own
* Charges API inherits the user subscription's VAT settings (configurable from the Sales Tax Settings page in the Seller Dashboard)
* You can only charge a card up to 5 times an hour (inclusive of scheduled subscription payments and one-off charges)
* Subscriptions in a paused state cannot be charged until it is restarted.


#### Make an immediate one-off charge on top of an existing user subscription

This feature is useful for scenarios where buyers need to purchase add-ons on top of a recurring plan.

For example, Charges API provides you with the flexibility to ch...