You are here

README.txt in Ubercart Stripe 7

This is an Ubercart payment gateway module for Stripe.

It includes integration with the Ubercart Recurring Payments
module for subscriptions.

Installation and Setup
======================

a) Install and enable the module in the normal way for Drupal.

b) Visit your Ubercart Store Administration page, Configuration
section, and enable the gateway under the Payment Gateways.
(admin/store/settings/payment/edit/gateways)

c) On this page, provide the following settings:
   - Your Stripe API key, private

d) Download and install the latest version of the PHP Stripe
library (https://github.com/stripe/stripe-php. Put it in
sites/all/libraries/stripe-php such that the path to Stripe.php
is sites/all/libraries/stripe-php/lib/Stripe.php

e) If you are using recurring payments, install version 2.x
of the Ubercart Recurring module:
http://drupal.org/project/uc_recurring
and set up as described below


Recurring Payments Setup
========================

First, you'll need the Ubercart Recurring module:
http://drupal.org/project/uc_recurring installed. It is not
listed as a dependency for this Stripe payment module because
this module could be used without recurring payments.
But it is a dependency to use the recurring payments piece of
this module.

Create a product in your Drupal site. After creating that
product, edit it and click on the "Features" tab. Under
"Add a new feature," select "Recurring fee" and click add.
In order for this to work with Stripe, you must select the
"Applicable SKU." This will create the subscription plan in
Stripe (provided of course that you have your API keys set up).
Then, later, when a user purchases this product, they will get
added as "Customers" to this "Plan."

Notes:

- Stripe doesn't have a way to set the number of billing periods.
So basically people are subscribed or unsubscribed, not
subscribed for 12 months then done. We hope to add the
ability to change this later, but we would have to do it
on our end. So for example, we would have to keep track of
the time since the subscription started in Drupal and send
Stripe a request when that time is up.


Todo
====
- Enable set number of billing periods. So the system will
keep track of the time and then shoot of a request to Stripe
via cron to cancel the subscription once the billing period is up.

File

README.txt
View source
  1. This is an Ubercart payment gateway module for Stripe.
  2. It includes integration with the Ubercart Recurring Payments
  3. module for subscriptions.
  4. Installation and Setup
  5. ======================
  6. a) Install and enable the module in the normal way for Drupal.
  7. b) Visit your Ubercart Store Administration page, Configuration
  8. section, and enable the gateway under the Payment Gateways.
  9. (admin/store/settings/payment/edit/gateways)
  10. c) On this page, provide the following settings:
  11. - Your Stripe API key, private
  12. d) Download and install the latest version of the PHP Stripe
  13. library (https://github.com/stripe/stripe-php. Put it in
  14. sites/all/libraries/stripe-php such that the path to Stripe.php
  15. is sites/all/libraries/stripe-php/lib/Stripe.php
  16. e) If you are using recurring payments, install version 2.x
  17. of the Ubercart Recurring module:
  18. http://drupal.org/project/uc_recurring
  19. and set up as described below
  20. Recurring Payments Setup
  21. ========================
  22. First, you'll need the Ubercart Recurring module:
  23. http://drupal.org/project/uc_recurring installed. It is not
  24. listed as a dependency for this Stripe payment module because
  25. this module could be used without recurring payments.
  26. But it is a dependency to use the recurring payments piece of
  27. this module.
  28. Create a product in your Drupal site. After creating that
  29. product, edit it and click on the "Features" tab. Under
  30. "Add a new feature," select "Recurring fee" and click add.
  31. In order for this to work with Stripe, you must select the
  32. "Applicable SKU." This will create the subscription plan in
  33. Stripe (provided of course that you have your API keys set up).
  34. Then, later, when a user purchases this product, they will get
  35. added as "Customers" to this "Plan."
  36. Notes:
  37. - Stripe doesn't have a way to set the number of billing periods.
  38. So basically people are subscribed or unsubscribed, not
  39. subscribed for 12 months then done. We hope to add the
  40. ability to change this later, but we would have to do it
  41. on our end. So for example, we would have to keep track of
  42. the time since the subscription started in Drupal and send
  43. Stripe a request when that time is up.
  44. Todo
  45. ====
  46. - Enable set number of billing periods. So the system will
  47. keep track of the time and then shoot of a request to Stripe
  48. via cron to cancel the subscription once the billing period is up.