It’s finally here! We’ve made significant changes to the codebase and are now compliant with stripe API version 2017-06-05.
I want to give a huge thanks to all of our contributors for their help in making this happen, especially Bill Huneke (@wahuneke) for his impressive design work and @jleclanche for really pushing this release along.
I also want to welcome onboard two more maintainers, @jleclanche and @lskillen. They’ve stepped up and have graciously dedicated their resources to making dj-stripe such an amazing package.
Almost all methods now mimic the parameters of those same methods in the stripe API. Note that some methods do not have some parameters implemented. This is intentional. That being said, expect all method signatures to be different than those in previous versions of dj-stripe.
Finally, please note that there is still a bit of work ahead of us. Not everything in the Stripe API is currently supported by dj-stripe – we’re working on it. That said, v1.0.0 has been thoroughly tested and is verified stable in production applications.
A few things to get excited for¶
- Multiple subscription support (finally)
- Multiple sources support (currently limited to Cards)
- Idempotency support (See #455, #460 for discussion – big thanks to @jleclanche)
- Full model documentation
- Objects that come through webhooks are now tied to the API version set in dj-stripe. No more errors if dj-stripe falls behind the newest stripe API version.
- Any create/update action on an object automatically syncs the object.
- Concurrent LIVE and TEST mode support (Thanks to @jleclanche). Note
that you’ll run into issues if
livemodeisn’t set on your existing customer objects.
- All choices are now enum-based (Thanks @jleclanche, See #520). Access
them from the new
djstripe.enumsmodule. The ability to check against model property based choices will be deprecated in 1.1
- Support for the Coupon model, and coupons on Customer objects.
- Support for the Payout/Transfer
split from api
What still needs to be done (in v1.1.0)¶
Documentation. Our original documentation was not very helpful, but it covered the important bits. It will be very out of date after this update and will need to be rewritten. If you feel like helping, we could use all the help we can get to get this pushed out asap.
Master sync re-write. This sounds scary, but really isn’t. The current management methods run sync methods on Customer that aren’t very helpful and are due for removal. My plan is to write something that first updates local data (via
sync_from_stripe_data) and then pulls all objects from Stripe and populates the local database with any records that don’t already exist there.
You might be wondering, “Why are they releasing this if there are only a few things left?” Well, that thinking turned this into a two year release... Trust me, this is a good thing.
Significant changes (mostly backwards-incompatible)¶
- Idempotency. #460 introduces idempotency keys and implements
Customer.get_or_create(). Idempotency will be enabled for all calls that need it.
- Improved Admin Interface. This is almost complete. See #451 and #452.
- Drop non-trivial endpoint views. We’re dropping everything except the webhook endpoint and the subscription cancel endpoint. See #428.
- Drop support for sending receipts. Stripe now handles this for you. See #478.
- Drop support for plans as settings, including custom plan hierarchy (if you want this, write something custom) and the dynamic trial callback. We’ve decided to gut having plans as settings. Stripe should be your source of truth; create your plans there and sync them down manually. If you need to create plans locally for testing, etc., simply use the ORM to create Plan models. The sync rewrite will make this drop less annoying.
- Orphan Customer Sync. We will now sync Customer objects from Stripe even if they aren’t linked to local subscriber objects. You can link up subscribers to those Customers manually.
- Concurrent Live and Test Mode. dj-stripe now supports test-mode and live-mode Customer objects concurrently. As a result, the User.customer One-to-One reverse-relationship is now the User.djstripe_customers RelatedManager. (Thanks @jleclanche) #440. You’ll run into some dj-stripe check issues if you don’t update your KEY settings accordingly. Check our GitHub issue tracker for help on this.
PAYMENT_PLANSobjects are removed. Use Plan.objects.all() instead.
plan_from_stripe_idfunction is removed. Use Plan.objects.get(stripe_id=)
- sync_plans no longer takes an api_key
- sync methods no longer take a
- All sync methods are now private. We’re in the process of building a better syncing mechanism.
- dj-stripe decorators now take a plan argument. If you’re passing in a
custom test function to
subscriber_passes_pay_test, be sure to account for this new argument.
- The context provided by dj-stripe’s mixins has changed.
- We’ve removed the SubscriptionPaymentRequiredMixin. Use
- dj-stripe middleware doesn’t support multiple subscriptions.
- Local custom signals are deprecated in favor of Stripe webhooks:
- The Event Handlers designed by @wahuneke are the new way to handle
events that come through webhooks. Definitely take a look at
SubscriptionCancellationFailureexceptions are removed. There should no longer be a case where they would have been useful. Catch native stripe errors in their place instead.
Charge.card_kindare removed. Use
Charge.source.brand(if the source is a Card)
Charge.invoiceis no longer a foreign key to the Invoice model.
Invoicenow has a OneToOne relationship with
Charge.invoicewill still work, but will no longer be represented in the database).
dj-stripe now supports test mode and live mode Customer objects concurrently (See #440). As a result, the
<subscriber_model>.customerOneToOne reverse relationship is no longer a thing. You should now instead add a
customerproperty to your subscriber model that checks whether you’re in live or test mode (see djstripe.settings.STRIPE_LIVE_MODE as an example) and grabs the customer from
<subscriber_model>.djstripe_customerswith a simple
Customer no longer has a
current_subscriptionproperty. We’ve added a
subscriptionproperty that should suit your needs.
With the advent of multiple subscriptions, the behavior of
Customer.subscribe()has changed. Before,
calling subscribe()when a customer was already subscribed to a plan would switch the customer to the new plan with an option to prorate. Now calling
subscribe()simply subscribes that customer to a new plan in addition to it’s current subsription. Use
Subscription.update()to change a subscription’s plan instead.
Customer.cancel_subscription()is removed. Use
Customer.update_plan_quantity()method is removed. Use
SubscriptionManagerand works on the
Subscriptionmodel instead of the
Customer.update_card()now takes an id. If the id is not supplied, the default source is updated.
Customer.stripe_customerproperty is removed. Use
Customer.cancel_subscription()now actually follows the DJSTRIPE_PRORATION_POLICY setting.
Customer.card_exp_yearare all removed. Check
Customer.default_source(if it’s a Card) or one of the sources in
Customer.sources(again, if it’s a Card) instead.
Customer.add_invoice_itemis now named
invoiceand can be either an Invoice object or the stripe_id of an Invoice.
Event.validated_message. Just check if the event is valid - no need to double check (we do that for you)
TransferChargeFeeis removed. It hasn’t been used in a while due to a broken API version. Use
Any fields that were in
Transfer.summaryno longer exist and are therefore deprecated (unused but not removed from the database). Because of this,
TransferManagernow only aggregates
InvoiceItems are no longer created when Invoices are synced. You must now sync InvoiceItems directly.
Plan no longer has a
Plan.currencyno longer uses choices. Use the
get_supported_currency_choices()utility and create your own custom choices list instead.
Plan interval choices are now in
Subscription.is_period_current()now checks for a current trial end if the current period has ended. This change means subscriptions extended with
Subscription.extend()will now be seen as valid.
We’ll sync your current records with Stripe in a migration. It will take a while, but it’s the only way we can ensure data integrity. There were some fields for which we needed to temporarily add placeholder defaults, so just make sure you have a customer with ID 1 and a plan with ID 1 and you shouldn’t run into any issues (create dummy values for these if need be and delete them after the migration).
BIG HUGE NOTE - DON’T OVERLOOK THIS¶
Subscription and InvoiceItem migration is not possible because old records don’t have Stripe IDs (so we can’t sync them). Our approach is to delete all local subscription and invoiceitem objects and re-sync them from Stripe.¶
We 100% recommend you create a backup of your database before performing this upgrade.¶
- Postgres users now have access to the
DJSTRIPE_USE_NATIVE_JSONFIELDsetting. (Thanks @jleclanche) #517, #523
- Charge receipts now take
DJSTRIPE_SEND_INVOICE_RECEIPT_EMAILSinto account (Thanks @r0fls)
- Clarified/modified installation documentation (Thanks @pydanny)
- Corrected and revised ANONYMOUS_USER_ERROR_MSG (Thanks @pydanny)
- Added fnmatching to
SubscriptionPaymentMiddleware.process_request()functionality broken up into multiple methods, making local customizations easier (Thanks @pydanny)
- Fully qualified events are now supported by event handlers as strings e.g. ‘customer.subscription.deleted’ (Thanks @lskillen) #316
- runtests now accepts positional arguments for declaring which tests to run (Thanks @lskillen) #317
- It is now possible to reprocess events in both code and the admin interface (Thanks @lskillen) #318
- The confirm page now checks that a valid card exists. (Thanks @scream4ik) #325
- Added support for viewing upcoming invoices (Thanks @lskillen) #320
- Event handler improvements and bugfixes (Thanks @lskillen) #321
- API list() method bugfixes (Thanks @lskillen) #322
- Added support for a custom webhook event handler (Thanks @lskillen) #323
- Django REST Framework contrib package improvements (Thanks @aleccool213) #334
tax_percentto CreateSubscriptionSerializer (Thanks @aleccool213) #349
- Fixed incorrectly assigned
application_feein Charge calls (Thanks @kronok) #382
- Fixed bug caused by API change (Thanks @jessamynsmith) #353
- Added inline documentation to pretty much everything and enforced docsytle via flake8 (Thanks @aleccool213)
- Fixed outdated method call in template (Thanks @kandoio) #391
- Customer is correctly purged when subscriber is deleted, regardless of how the deletion happened (Thanks @lskillen) #396
- Test webhooks are now properly captured and logged. No more bounced requests to Stripe! (Thanks @jameshiew) #408
- CancelSubscriptionView redirect is now more flexible (Thanks @jleclanche) #418
- Customer.sync_cards() (Thanks @jleclanche) #438
- Many stability fixes, bugfixes, and code cleanup (Thanks @jleclanche)
- Support syncing cancelled subscriptions (Thanks @jleclanche) #443
- Improved admin interface (Thanks @jleclanche with @jameshiew) #451
- Support concurrent TEST + LIVE API keys (Fix webhook event processing for both modes) (Thanks @jleclanche) #461
- Added Stripe Dashboard link to admin change panel (Thanks @jleclanche) #465
Plan.amount_in_cents(Thanks @jleclanche) #466
Subscription.reactivate()(Thanks @jleclanche) #470
Plan.human_readable_price(Thanks @jleclanche) #498
- (Re)attach the Subscriber when we find it’s id attached to a customer on Customer sync (Thanks @jleclanche) #500
- Made API version configurable (with dj-stripe recommended default) (Thanks @lskillen) #504
- better plan ordering documentation (Thanks @cjrh)
- added a confirmation page when choosing a subscription (Thanks @chrissmejia, @areski)
- setup.py reverse dependency fix (#258/#268) (Thanks @ticosax)
- Dropped official support for Django 1.7 (no code changes were made)
- Python 3.5 support, Django 1.9.1 support
- Migration improvements (Thanks @michi88)
- Fixed “Invoice matching query does not exist” bug (#263) (Thanks @mthornhill)
- Fixed duplicate content in account view (Thanks @areski)
- dj-stripe now responds to the invoice.created event (Thanks @wahuneke)
- dj-stripe now cancels subscriptions and purges customers during sync if they were deleted from the stripe dashboard (Thanks @unformatt)
- dj-stripe now checks for an active stripe subscription in the
update_plan_quantitycall (Thanks @ctrengove)
- Event processing is now handled by “event handlers” - functions outside of models that respond to various event types and subtypes. Documentation on how to tie into the event handler system coming soon. (Thanks @wahuneke)
- Experimental Python 3.5 support
- Support for Django 1.6 and lower is now officially gone.
- Much, much more!
- Support for Django 1.6 and lower is now deprecated.
- Improved test harness now tests coverage and pep8
- SubscribeFormView and ChangePlanView no longer populate self.error with form errors
- InvoiceItems.plan can now be null (as it is with individual charges), resolving #140 (Thanks @awechsler and @MichelleGlauser for help troubleshooting)
- Email templates are now packaged during distribution.
- sync_plans now takes an optional api_key
- 100% test coverage
- Stripe ID is now returned as part of each model’s str method (Thanks @areski)
- Customer model now stores card expiration month and year (Thanks @jpadilla)
- Ability to extend subscriptions (Thanks @TigerDX)
- Support for plan heirarchies (Thanks @chrissmejia)
- Rest API endpoints for Subscriptions [contrib] (Thanks @philippeluickx)
- Admin interface search by email funtionality is removed (#221) (Thanks @jpadilla)
- Began deprecation of support for Django 1.6 and lower.
- Added formal support for Django 1.8.
- Removed the StripeSubscriptionSignupForm
djstripe.safe_settings. Settings are now all located in
DJSTRIPE_TRIAL_PERIOD_FOR_SUBSCRIBER_CALLBACKcan no longer be a module string
- The sync_subscriber argument has been renamed from subscriber_model to subscriber
- Moved available currencies to the DJSTRIPE_CURRENCIES setting (Thanks @martinhill)
- Allow passing of extra parameters to stripe Charge API (Thanks @mthornhill)
- Support for all available arguments when syncing plans (Thanks @jamesbrobb)
- charge.refund() now returns the refunded charge object (Thanks @mthornhill)
- Charge model now has captured field and a capture method (Thanks @mthornhill)
- Subscription deleted webhook bugfix
- South migrations are now up to date (Thanks @Tyrdall)
- Formal Python 3.3+/Django 1.7 Support (including migrations)
- Removed Python 2.6 from Travis CI build. (Thanks @audreyr)
- Dropped Django 1.4 support. (Thanks @audreyr)
- Deprecated the
djstripe.forms.StripeSubscriptionSignupForm. Making this form work easily with both
django-allauthrequired too much abstraction. It will be removed in the 0.5.0 release.
- Add the ability to add invoice items for a customer (Thanks @kavdev)
- Add the ability to use a custom customer model (Thanks @kavdev)
- Added setting to disable Invoice receipt emails (Thanks Chris Halpert)
- Enable proration when customer upgrades plan, and pass proration policy and cancellation at period end for upgrades in settings. (Thanks Yasmine Charif)
- Removed the redundant context processor. (Thanks @kavdev)
- Fixed create a token call in change_card.html (Thanks @dollydagr)
charge.dispute.closedtypo. (Thanks @ipmb)
- Fix contributing docs formatting. (Thanks @audreyr)
- Fix subscription cancelled_at_period_end field sync on plan upgrade (Thanks @nigma)
- Remove “account” bug in Middleware (Thanks @sromero84)
- Fix correct plan selection on subscription in subscribe_form template. (Thanks Yasmine Charif)
- Fix subscription status in account, _subscription_status, and cancel_subscription templates. (Thanks Yasmine Charif)
- Now using
user.username, to support custom User models. (Thanks @shvechikov)
- Update remaining DOM Ids for Bootstrap 3. (Thanks Yasmine Charif)
- Update publish command in setup.py. (Thanks @pydanny)
- Explicitly specify tox’s virtual environment names. (Thanks @audreyr)
- Manually call django.setup() to populate apps registry. (Thanks @audreyr)
djstripe_init_customersmanagement command so it works with custom user models.
- Clarify documentation for redirects on app_name.
- If settings.DEBUG is True, then django-debug-toolbar is exempt from redirect to subscription form.
- Use collections.OrderedDict to ensure that plans are listed in order of price.
ordereddictlibrary to support Python 2.6 users.
- Switch from
__str__methods on models to better support Python 3.
python_2_unicode_compatibledecorator to Models.
- Check for PY3 so the
unicode(self.user)in models.Customer doesn’t blow up in Python 3.
- Increased the extendability of the views by removing as many hard-coded URLs as possible and replacing them with
success_urland other attributes/methods.
- Added single unit purchasing to the cookbook
- Made Yasmine Charif a core committer
- Take into account trial days in a subscription plan (Thanks Yasmine Charif)
- Correct invoice period end value (Thanks Yasmine Charif)
- Make plan cancellation and plan change consistently not prorating (Thanks Yasmine Charif)
- Fix circular import when ACCOUNT_SIGNUP_FORM_CLASS is defined (Thanks Dustin Farris)
- Add send e-mail receipt action in charges admin panel (Thanks Buddy Lindsay)
createdfield to all ModelAdmins to help with internal auditing (Thanks Kulbir Singh)
- Cancellation fix (Thanks Yasmine Charif)
- Add setup.cfg for wheel generation (Thanks Charlie Denton)
- Fully tested against Django 1.6, 1.5, and 1.4
- Fix boolean default issue in models (from now on they are all default to
- Replace duplicated code with
- Cancellation added to views.
- Support for kwargs on charge and invoice fetching.
- def charge() now supports send_receipt flag, default to True.
- Fixed templates to work with Bootstrap 3.0.0 column design.
- Improved usage documentation.
- Corrected order of fields in StripeSubscriptionSignupForm.
- Corrected transaction history template layout.
- Updated models to take into account when settings.USE_TZ is disabled.
- Add handy rest_framework permission class.
- Fixing attribution for django-stripe-payments.
- Add new status to Invoice model.
- Changed name of division tag to djdiv.
safe_setting.pymodule to handle edge cases when working with custom user models.
- Added cookbook page in the documentation.
- Fixed bug in initial checkout
- You can’t purchase the same plan that you currently have.
- Recursive package finding.
- Fix packaging so all submodules are loaded
- Added Registration + Subscription form
- Fixed a bug on CurrentSubscription tests
- Improved usage documentation
- Added to migration from other tools documentation
- Cancellation of plans now works.
- Upgrades and downgrades of plans now work.
- Changing of cards now works.
- Added breadcrumbs to improve navigation.
- Improved installation instructions.
- Consolidation of test instructions.
- Minor improvement to django-stripe-payments documentation
- Added coverage.py to test process.
- Added south migrations.
- Fixed the subscription_payment_required function-based view decorator.
- Removed unnecessary django-crispy-forms
- Middleware excepts all of the djstripe namespaced URLs. This way people can pay.
- Fixed a couple template paths
- Fixed the manifest so we include html, images.
- Fixed the manifest so we include html, css, js, images.
- Change PaymentRequiredMixin to SubscriptionPaymentRequiredMixin
- Add subscription_payment_required function-based view decorator
- Added SubscriptionPaymentRedirectMiddleware
- Much nicer accounts view display
- Much improved subscription form display
- Payment plans can have decimals
- Payment plans can have custom images
- Added account view
- Added Customer.get_or_create method
- Added djstripe_sync_customers management command
- sync file for all code that keeps things in sync with stripe
- More user friendly action views
- Admin working
- Better publish statement
- Fix dependencies
- Ported internals from django-stripe-payments
- Began writing the views
- All tests passing on Python 2.7 and 3.3
- All tests passing on Django 1.4 and 1.5
- Began model cleanup
- Better form
- Provide better response from management commands
- First release on PyPI.