In the first part of this series, we created a Django online shop with htmx.
In this second part, we'll handle orders using Stripe.
What We'll Do
We'll integrate Stripe to handle payments securely. This is what we want to achieve:
- In the
purchase
view, we start by creating a Stripe checkout session and redirect the customer to the corresponding URL. This is where we tell Stripe about the product we are selling, its quantity, and where the customer should be redirected to after a successful purchase (thesuccess_url
). - The customer fills in their payment details on the Stripe checkout page and completes the payment. Stripe then makes a POST request to a webhook endpoint on our website, where we listen to events and process them accordingly. If the payment is successful, we save the order in our database and notify the customer (and our staff users) about the purchase.
- Finally, if the webhook returns a response with a 200 OK HTTP status code, Stripe redirects to the
success_url
created in the first step.
Setting Up Stripe for Our Django Python Store
We first need to jump over to Stripe and do the following:
1: Create a Stripe Account
Start by creating a Stripe account. For now, you don’t really need to activate your account. You can just work in test mode, which will prevent you from making real payments while testing. Go to the API keys page and retrieve the publishable and secret keys. Save them in your project environment variables (STRIPE_PUBLISHABLE_KEY
and STRIPE_SECRET_KEY
). We will use these keys to authenticate your Stripe requests.
2: Create Your Product
Create a new product on the products page. Fill out the details and set the payment type to one-off. Your product should look something like this:
Once you press Add product, you should be able to see your product on the product list. If you click on it and scroll down to the Pricing section, you can find the API ID for the price item you created — it should be something like price_3ODP5…
. Save it in an environment variable (STRIPE_PRICE_ID
): you will need this when creating the Stripe checkout session.
3: Create the Webhook
We need to create a webhook endpoint for Stripe to call when a payment completes. In the webhooks page, choose to test in the local environment. This will allow you to forward the request to a local URL, like http://127.0.0.1:8000. Start by downloading the Stripe CLI. Then, you can:
- Log into Stripe
- Forward events to the webhook endpoint that you will create:
This ensures that once a purchase is made, Stripe forwards the webhook calls to your local endpoint. The command will log a webhook signing secret, which you should also save as a project environment variable (STRIPE_WEBHOOK_SECRET
). This will prove useful for verifying that a request does indeed come from Stripe and that you are handling the right webhook.
By the end of this section, you should have four Stripe environment variables. You can now load them in ecommerce_site/settings.py
:
Note: We are using python-dotenv to load the environment variables.
Extend the Views
We now need to extend the views to integrate Stripe by creating a checkout session, a successful purchase view, and a webhook view.
1: Create a Stripe Checkout Session
In the purchase
view, we'll create a Stripe checkout session if the purchase form is valid:
Let’s break this down:
- We first set the Stripe API key.
- We then create a successful purchase URL pointing to the
purchase_success
view (which we'll create in the next step). Stripe should automatically populate theCHECKOUT_SESSION_ID
. - We create a URL for when a purchase is canceled — for example, when the customer changes their mind. In this case, it’s just the home view.
- We create a Stripe checkout session with our price ID (the product identifier) and the quantity the customer wants to purchase.
- Stripe returns a session object from which we can extract the URL and redirect the customer. Since this request is coming from htmx, we can’t really use the standard Django redirect function. Instead, we use the django-htmx package, which provides this
HttpResponseClientRedirect
class.
2: Create the Successful Purchase View
After completing the purchase, Stripe will redirect the customer to our specified success_url
. Here, we can handle the post-purchase logic:
In this view, we first check if the session_id
query parameter is present. If it is, we retrieve the corresponding session from Stripe using the secret key and the session_id
. We then render the successful purchase template, which looks like this:
You should also add it to the urlpatterns
:
3: Create the Webhook View
While the customer is in the purchase process, and before they are redirected to the success view, Stripe will call our webhook endpoint (remember to have the webhook listener running, as explained in the earlier 'Create the Webhook' section of this post):
Let’s break this down:
- We try to construct a Stripe event from the payload, the signature header, and the webhook secret: the first is used to build the actual event, and the last two variables are relevant to validate the authenticity of the request.
- If the signature verification fails, we return a 400 HTTP response. Remember that Stripe is actually calling this endpoint, not our customer, so Stripe will know what to do in this scenario.
- We check if the event type is
checkout.session.completed
, i.e., if a customer successfully paid for our product. For now, we don’t do much else here, but we will process the order in the next step.
Note: A Stripe event can have multiple types but we will only handle completed sessions in this post. However, you can (and should) extend a webhook by following the docs.
You should also add this view to urlpatterns
:
If everything works well, once you click “buy”, you should be redirected to a Stripe payment page. Since we are in test mode, we can fill in the payment details with dummy data, like a 4242 4242 4242 4242
card:
Once you press Pay, Stripe should call the webhook view and redirect you to the purchase_success
view. Congratulations, you have successfully processed a payment with Stripe!
Create the Orders and Notify Users
Once a purchase is completed, we need to do a few things in the webhook view:
- Save the order information in our database.
- Notify staff users about the recent purchase.
- Send a confirmation email to the customer.
Let’s create a LineOrder
database model in ecommerce/models.py
to store some of the order information:
Remember to create and run the migrations:
We can now create a function to process the orders and call it from the webhook view:
Let’s break this down:
- We first create line order instances from the Stripe session and send a confirmation email to the customer about their purchase.
- We then send an email to all staff users telling them to check the admin panel.
You can now register the LineOrder
model in the admin panel, so it’s accessible to staff users:
When staff users log in to the admin page, they will now be able to check new orders and process them accordingly — in this case, pack and ship mugs to the customer!
Some Tips to Optimize Your Django Store
Here are some tips to further improve on the store you've built:
- Write tests - you can see some examples in the GitHub repository.
- If you have more products to sell, create a database model for them, and connect the
LineOrder
through aForeignKey
. - Configure email settings according to Django's email documentation. You can also use libraries such as django-post-office to manage your email templates and queues.
- Once you deploy your website, create an actual webhook (not a local listener).
- Take a look at the Stripe docs for alternatives to the checkout process we've outlined, including an embedded checkout form.
Wrapping Up
In this two-part series, we successfully built a one-product e-commerce site using Django, htmx, and Stripe. This guide has walked you through setting up your Django project, integrating htmx for seamless user interactions, and incorporating secure payments with Stripe.
We also covered how to handle order processing, including saving order information to your database, notifying staff users of new purchases, and sending confirmation emails to your customers. With these foundations, you can further customize and expand your e-commerce site to suit your specific needs.
Happy coding!
P.S. If you'd like to read Python posts as soon as they get off the press, subscribe to our Python Wizardry newsletter and never miss a single post!