Stripe::Subscribe: Stripe subscriptions made easy

🔴 This gem is still in Alpha and has not been tested on Production 🔴

This is a Rails Engine that makes it easy to work with Stripe Subscriptions. It provides,

• views and controllers for showing Stripe plans
• integrated with views and controllers for payments
• methods on any Devise resource to fetch it's Stripe subscriptions

Checking a user's subscription and getting the user to subscribe to a plan can be as simple as,

# app/controllers/paid_features_controller.rb
class PaidFeaturesController < ApplicationController
  def show
    if current_user.stripe_active_subcsription? # checks subscription from Stripe
      render
    else
      redirect_to stripe_subscribe.plans_path # to select and pay for a plan
    end
  end
end

📫 Sign up for the Newsletter to receive occasional updates.

On the road-map: handling cancellations, switching plans, trials, coupons, discounts, dealing with refunds. Feel free to post an issue if I'm missing anything.

Installation

Add this line to your application's Gemfile:

gem 'stripe-subscribe', github: 'tansengming/stripe-subscribe'

And then execute:

$ bundle

Install and run the migrations:

$ rails stripe_subscribe:install:migrations
$ rails db:migrate

Getting Started

These are the files that have to be updated on your Rails app. Don't panic.

.
├─ config
│  ├─ stripe
│  │  └─ plans.rb
│  └─ routes.rb
└─ app
   ├─ models
   │  └─ user.rb
   └─ controllers
      └─ paid_features_controller.rb

Configure your plans at config/stripe/plans.rb. The plans defined here will be uploaded to Stripe and used to render the plans page,

# config/stripe/plans.rb
Stripe.plan :pro do |plan|
  plan.name = 'Professional'
  plan.amount = 1999
  plan.currency = 'usd'
  plan.interval = 'month'
end

Run this to upload the plans to Stripe,

$ rake stripe:prepare

Update the routes to mount the engine. This will be the routes where users get to select a plan and pay for it. Make sure it is mounted within Devise's authenticate helper so only authenticated users get access.

# config/routes.rb
Rails.application.routes.draw do
  authenticate :user do
    mount Stripe::Subscribe::Engine => "/stripe/subscribe"
  end
end

Include the module to mix in Stripe subscription methods to the User. E.g. #stripe_active_subcsription?, stripe_customer etc.

# app/models/user.rb
class User < ApplicationRecord
  include Stripe::Subscriberable
end

You are now ready for user subscriptions on Stripe!

You can use the new methods to retrieve a user's subscription status on the controller and block access to the action until they become a subscriber.

Redirecting users to stripe_subscribe.plans_path will take the user to a page with the plans listed on config/stripe/plans.rb. They will then be able to select a plan and pay for them on those pages.

# app/controllers/paid_features_controller.rb
class PaidFeaturesController < ApplicationController
  def show
    if current_user.stripe_active_subcsription?
      render
    else
      redirect_to stripe_subscribe.plans_path
    end
  end
end

Customizing

TBD

Architecture

The engine is built simply but is highly coupled with Stripe, Devise and Rails.

Details TBD

Contributing

TBD

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms, which can be found in the CODE_OF_CONDUCT.md file in this repository.