Stripe Models for Django.
dj-stripe implements all of the Stripe models, for Django. Set up your webhook and start receiving model updates. You will then have a copy of all the Stripe models available in Django models, no API traffic required!
The full documentation is available here: https://dj-stripe.readthedocs.io/
- Subscriptions
- Individual charges
- Stripe Sources
- Stripe v2 and v3 support
- Tested with Stripe API 2019-05-16 (see https://dj-stripe.readthedocs.io/en/latest/api_versions.html )
- Django >= 2.1
- Python >= 3.4
- Supports Stripe exclusively. For PayPal, see dj-paypal instead.
- PostgreSQL engine (recommended): >= 9.4
- MySQL engine: MariaDB >= 10.2 or MySQL >= 5.7
Install dj-stripe:
pip install dj-stripe
Add djstripe
to your INSTALLED_APPS
:
INSTALLED_APPS =(
...
"djstripe",
...
)
Tell Stripe about the webhook (Stripe webhook docs can be found here) using the full URL of your endpoint from the urls.py step above (e.g. https://example.com/stripe/webhook
).
Add your Stripe keys and set the operating mode:
STRIPE_LIVE_PUBLIC_KEY = os.environ.get("STRIPE_LIVE_PUBLIC_KEY", "<your publishable key>")
STRIPE_LIVE_SECRET_KEY = os.environ.get("STRIPE_LIVE_SECRET_KEY", "<your secret key>")
STRIPE_TEST_PUBLIC_KEY = os.environ.get("STRIPE_TEST_PUBLIC_KEY", "<your publishable key>")
STRIPE_TEST_SECRET_KEY = os.environ.get("STRIPE_TEST_SECRET_KEY", "<your secret key>")
STRIPE_LIVE_MODE = False # Change to True in production
DJSTRIPE_WEBHOOK_SECRET = "whsec_xxx" # Get it from the section in the Stripe dashboard where you added the webhook endpoint
Add some payment plans via the Stripe.com dashboard.
Add to urls.py:
path("stripe/", include("djstripe.urls", namespace="djstripe")),
Run the commands:
python manage.py migrate python manage.py djstripe_init_customers python manage.py djstripe_sync_plans_from_stripe
Assuming the tests are run against PostgreSQL:
createdb djstripe pip install tox tox
This project follows best practices as espoused in Two Scoops of Django: Best Practices for Django 1.11.