Django + Stripe Made Easy

• Subscription management
• Designed for easy implementation of post-registration subscription forms
• Single-unit purchases
• Works with Django >= 2.2
• Works with Python >= 3.6
• Built-in migrations
• Dead-Easy installation
• Leverages the best of the 3rd party Django package ecosystem
• djstripe namespace so you can have more than one payments related app
• Documented
• 100% Tested

Contents

Getting Started

• Installation
  • Get the distribution
  • Configuration
  • Running Tests
• A note on Stripe API versions
  • Your Stripe account’s API version
  • Stripe’s current latest API version
  • dj-stripe’s API version
  • dj-stripe’s tested version (as mentioned in README)
• A note on Stripe Elements JS methods
  • Payment Intents (SCA compliant)
  • Charges using stripe.createSource()
  • Charges using stripe.createToken()

Usage

• Checking if a customer has a subscription
• Subscribing a customer to a plan
• Creating a one-off charge for a customer
• Restricting access to only active subscribers
  • Constraining Entire Sites
  • Constraining Class-Based Views
  • Constraining Function-Based Views
  • Don’t do this!
• Managing subscriptions and payment sources
  • Extending subscriptions
• Creating invoices
  • Adding line items to invoices
• Running reports
• Webhooks
  • Using webhooks in dj-stripe
  • Official documentation
• Manually syncing data with Stripe
  • Command line
  • In Code
• Cookbook
  • Customer User Model has_active_subscription property
  • Making individual purchases
  • REST API

Reference

• Context Managers
  • Temporary API Version
• Decorators
  • Standard Decorators
    • Payment Required
  • Event Handling Decorators
    • Specific Event(s) Handler
    • All Events Handler
• Enumerations
  • ApiErrorCode
  • AccountType
  • BalanceTransactionStatus
  • BalanceTransactionType
  • BankAccountHolderType
  • BankAccountStatus
  • BusinessType
  • CaptureMethod
  • CardCheckResult
  • CardBrand
  • CardFundingType
  • CardTokenizationMethod
  • ChargeStatus
  • ConfirmationMethod
  • CouponDuration
  • CustomerTaxExempt
  • DisputeReason
  • DisputeStatus
  • FileUploadPurpose
  • FileUploadType
  • InvoiceCollectionMethod
  • IntentUsage
  • IntentStatus
  • PaymentIntentStatus
  • SetupIntentStatus
  • PayoutFailureCode
  • PayoutMethod
  • PayoutStatus
  • PayoutType
  • PlanAggregateUsage
  • PlanBillingScheme
  • PlanInterval
  • PlanUsageType
  • PlanTiersMode
  • ProductType
  • ScheduledQueryRunStatus
  • SourceFlow
  • SourceStatus
  • SourceType
  • LegacySourceType
  • RefundFailureReason
  • RefundReason
  • RefundStatus
  • SourceUsage
  • SourceCodeVerificationStatus
  • SourceRedirectFailureReason
  • SourceRedirectStatus
  • SubmitTypeStatus
  • SubscriptionStatus
• Managers
  • SubscriptionManager
  • TransferManager
  • ChargeManager
• Middleware
  • SubscriptionPaymentMiddleware
• Models
  • Core Resources
    • Balance Transaction
    • Charge
    • Customer
    • Dispute
    • Event
    • File Upload
    • Payout
    • PaymentIntent
    • Product
    • Refund
  • Payment Methods
    • BankAccount
    • Card
    • PaymentMethod
    • Source
  • Billing
    • Coupon
    • Invoice
    • InvoiceItem
    • Plan
    • Subscription
    • SubscriptionItem
    • TaxRate
    • UpcomingInvoice
    • UsageRecord
  • Connect
    • Account
    • Application Fee
    • Country Spec
    • Transfer
    • Transfer Reversal
  • Fraud
  • Orders
  • Sigma
    • ScheduledQueryRun
  • Webhooks
    • WebhookEventTrigger
• Settings
  • STRIPE_API_VERSION (=‘2019-05-16’)
  • DJSTRIPE_IDEMPOTENCY_KEY_CALLBACK (=djstripe.settings._get_idempotency_key)
  • DJSTRIPE_PRORATION_POLICY (=False)
  • DJSTRIPE_SUBSCRIPTION_REQUIRED_EXCEPTION_URLS (=())
  • DJSTRIPE_SUBSCRIBER_CUSTOMER_KEY (=”djstripe_subscriber”)
  • DJSTRIPE_SUBSCRIBER_MODEL (=settings.AUTH_USER_MODEL)
  • DJSTRIPE_SUBSCRIBER_MODEL_MIGRATION_DEPENDENCY (=”__first__”)
  • DJSTRIPE_SUBSCRIBER_MODEL_REQUEST_CALLBACK (=None)
  • DJSTRIPE_USE_NATIVE_JSONFIELD (=False)
  • DJSTRIPE_WEBHOOK_URL (=r”^webhook/$”)
  • DJSTRIPE_WEBHOOK_SECRET (=”“)
  • DJSTRIPE_WEBHOOK_VALIDATION= (=”verify_signature”)
  • DJSTRIPE_WEBHOOK_TOLERANCE (=300)
  • DJSTRIPE_WEBHOOK_EVENT_CALLBACK (=None)
  • STRIPE_API_HOST (= unset)
• Utilities
  • Subscriber Has Active Subscription Check
  • Supported Currency Choice Generator
  • Clear Expired Idempotency Keys
  • Convert Stripe Timestamp to Datetime
  • Friendly Currency Amount String

Project

• Contributing
  • Types of Contributions
    • Report Bugs
    • Fix Bugs
    • Implement Features
    • Write Documentation
    • Submit Feedback
    • Contributor Discussion
  • Get Started!
  • Preferred Django Model Field Types
    • Strings
    • Enumerations
    • Hash (dictionaries)
    • Currency amounts
    • Dates and Datetimes
  • Django Migration Policy
    • Avoid new migrations with non-schema changes
    • Squash of unreleased migrations on master
  • Pull Request Guidelines
• Test Fixtures
  • Rationale
  • Regenerating the test fixtures
• Credits
  • Development Lead
  • Contributors
• History
  • 2.3.0 (2020-04-19)
    • Warning about safe uninstall of jsonfield2 on upgrade
  • 2.2.2 (2020-01-20)
  • 2.2.1 (2020-01-14)
  • 2.2.0 (2020-01-13)
    • Warning about safe uninstall of jsonfield on upgrade
    • Note on usage of Stripe Elements JS
  • 2.1.1 (2019-10-01)
    • Upcoming migration of currency fields (storage as cents instead of dollars)
  • 2.1.0 (2019-09-12)
    • Squashed dev migrations
  • 2.0.5 (2019-09-12)
  • 2.0.4 (2019-09-09)
  • 2.0.3 (2019-06-11)
  • 2.0.2 (2019-06-09)
  • 2.0.1 (2019-04-29)
  • 2.0.0 (2019-03-01)
  • 1.2.4 (2019-02-27)
  • 1.2.3 (2018-10-13)
  • 1.2.2 (2018-08-11)
  • 1.2.1 (2018-07-18)
  • 1.2.0 (2018-06-11)
  • 1.1.0 (2018-06-11)
    • Migration reset
    • Python 2.7 end-of-life
    • Backwards-incompatible changes and deprecations
      • Removal of polymorphic models
      • Full support for Stripe Sources (Support for v3 stripe.js)
      • Core fields renamed
  • 1.0.0 (2017-08-12)
    • A few things to get excited for
    • What still needs to be done (in v1.1.0)
    • Significant changes (mostly backwards-incompatible)
    • SETTINGS
    • SYNCING
    • UTILITIES
    • MIXINS
    • MIDDLEWARE
    • SIGNALS
    • WEBHOOK EVENTS
    • EXCEPTIONS
    • MODELS
    • MIGRATIONS
    • BIG HUGE NOTE - DON’T OVERLOOK THIS
    • Other changes
  • 0.8.0 (2015-12-30)
  • 0.7.0 (2015-09-22)
  • 0.6.0 (2015-07-12)
  • 0.5.0 (2015-05-25)
  • 0.4.0 (2015-04-05)
  • 0.3.5 (2014-05-01)
  • 0.3.4 (2014-05-01)
  • 0.3.3 (2014-04-24)
  • 0.3.2 (2014-01-16)
  • 0.3.1 (2013-11-14)
  • 0.3.0 (2013-11-12)
  • 0.2.9 (2013-09-06)
  • 0.2.8 (2013-09-02)
  • 0.2.7 (2013-08-24)
  • 0.2.6 (2013-08-20)
  • 0.2.5 (2013-08-18)
  • 0.2.4 (2013-08-18)
  • 0.2.3 (2013-08-16)
  • 0.2.2 (2013-08-15)
  • 0.2.1 (2013-08-12)
  • 0.2.0 (2013-08-12)
  • 0.1.7 (2013-08-08)
  • 0.1.6 (2013-08-08)
  • 0.1.5 (2013-08-08)
  • 0.1.4 (2013-08-08)
  • 0.1.3 (2013-08-7)
  • 0.1.2 (2013-08-6)
  • 0.1.1 (2013-08-6)
  • 0.1.0 (2013-08-5)
• Support
• Release Process
  • Squash migrations
  • Tag + package squashed migrations as rc package (optional)
  • Prepare changes for the release commit
  • Create signed release commit tag
  • Update/create stable branch
  • Configure readthedocs
  • Release on pypi

Constraints

1. For stripe.com only
2. Only use or support well-maintained third-party libraries
3. For modern Python and Django