Skip to main content

Django + Paddle Made Easy

Project description

PyPI Travis Documentation Supported Python versions License

Django + Paddle Made Easy

(this project is heavily inspired by dj-stripe)


dj-paddle implements Paddle models (currently Subscription only), for Django. Set up your webhook and start receiving model updates. You will then have a copy of all Paddle subscriptions available in Django, no API traffic required!

The full documentation is available at


  • Django Signals for all incoming webhook events from paddle

  • Subscriptions


  • Django >= 2.1

  • Python >= 3.5


Install dj-paddle:

pip install dj-paddle

Add djpaddle to your INSTALLED_APPS:


Add to

path("paddle/", include("djpaddle.urls", namespace="djpaddle")),

Tell paddle about the webhook (paddle webhook docs can be found here) using the full URL of your endpoint from the step above (e.g.

Add your paddle keys and set the operating mode:

# can be found at
DJPADDLE_VENDOR_ID = '<your-vendor-id>'

# create one at
DJPADDLE_API_KEY = '<your-api-key>'

# can be found at
DJPADDLE_PUBLIC_KEY = '<your-public-key>'

djpaddle includes a vendor_id template context processor which adds your vendor ID as DJPADDLE_VENDOR_ID to each template context:

    'OPTIONS': {
        'context_processors': [

Run the commands:

python migrate

# fetches all subscription plans from paddle
python djpaddle_sync_plans_from_paddle

Paddle Checkout

Next to setup a PaddleJS checkout page

First load in PaddleJS and initialise it by including the dj-paddle PaddleJS template in your own template to load PaddleJS:

{% include "djpaddle_paddlejs.html" %}

Next add a Paddle product or subscription plan into the page context. Below is an example of how to do this using a class based view where plan_id is passed through as a value from the URL:

from django.conf import settings
from django.views.generic import TemplateView
from djpaddle.models import Plan

class Checkout(TemplateView):
    template_name = 'checkout.html'

    def get_context_data(self, **kwargs):
        context = super().get_context_data(**kwargs)
        context['paddle_plan'] = Plan.objects.get(pk=kwargs['plan_id'])
        # If you have not added 'djpaddle.context_processors.vendor_id' as a template context processors
        context['DJPADDLE_VENDOR_ID'] = settings.DJPADDLE_VENDOR_ID
        return context

Finally put a Buy Now! button for the plan subscription you added to the context:

<a href="#!" class="paddle_button" data-product="{{ }}">Buy Now!</a>

You can pass data to Paddle JS by add data attributes to the button. For example to set the users email you can use the data-email attribute:

<a href="#!" class="paddle_button" data-product="{{ }}" data-email="{{ }}" >Buy Now!</a>

A full list of parameters can be found on the PaddleJS parameters page

For more information about options on what to do after a successful checkout please see our Checkout success documentation

Subscription model

You can override the model that subscriptions are attached to using the DJPADDLE_SUBSCRIBER_MODEL setting. This setting must use the string model reference in the style ‘app_label.ModelName’.

The model chosen must have an email field.

# Defaults to AUTH_USER_MODEL

Warning: To use this setting you must have already created and ran the initial migration for the app/model before adding djpadding to INSTALLED_APPS.

Reporting Security Issues

Please do not report security issues in public, but email the authors directly.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dj-paddle-0.1.2.tar.gz (13.4 kB view hashes)

Uploaded Source

Built Distribution

dj_paddle-0.1.2-py3-none-any.whl (18.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page