• Stars
    star
    790
  • Rank 57,622 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 4 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Create subscriptions with fixed prices or usage based billing.

Set up subscriptions with Stripe Billing

This sample shows how to create a customer and subscribe them to a plan with Stripe Billing. For the official documentation for Stripe billing checkout the overview.

Checkout Fixed-price-subscriptions with Elements Usage-based-subscriptions with Elements
Demo checkout.stripe.dev
Define prices in: CLI, Dashboard, or API Create a price with the Stripe: CLI, Dashboard, or API. βœ… βœ… βœ…
Charge users a fixed price on a recurring basis Create a subscription with a fixed price recurring monthly/yearly/etc. βœ… βœ…
Charge customers based on their usage. Create a metered subscriptions so you can charge customers based on their usage. βœ… βœ…
Apple Pay & Google Pay support βœ… Built in, no extra code needed
Coupon support for subscriptions βœ… βœ… βœ…

The hosted demos linked above are running in test mode -- use 4242424242424242 as a test card number with any CVC + future expiration date.

Use the 4000002500003155 test card number to trigger a 3D Secure challenge flow.

Read more about test cards on Stripe at https://stripe.com/docs/testing.

Run the sample locally

This sample can be installed two ways -- Stripe CLI or git clone. The .env configuration will vary depending on which way you install.

Requirements

Installing the sample

The Stripe CLI is the fastest way to clone and configure a sample to run locally and is the recommended approach as it will only download the code required for the server language you select. Alternatively, you can download and run directly with this repository.

Option 1: Installing with Stripe CLI

  1. If you haven't already installed the CLI, follow the installation steps. The CLI is useful for cloning samples and locally testing webhooks and Stripe integrations.

  2. Ensure the CLI is linked to your Stripe account by running:

stripe login
  1. Start the sample installer and follow the prompts with:
stripe samples create subscription-use-cases

The CLI will walk you through picking your integration type, server and client languages, and partially configuring your .env file with your Stripe API keys.

  1. Move into the server directory:
cd subscription-use-cases/server
  1. Open server/.env. The STATIC_DIR value should be ../client when installed using the Stripe CLI.
# Stripe keys
STRIPE_PUBLISHABLE_KEY=pk_12345
STRIPE_SECRET_KEY=sk_12345
STRIPE_WEBHOOK_SECRET=whsec_1234

# Stripe key for React front end
REACT_APP_STRIPE_PUBLISHABLE_KEY=pk_12345

# Environment variables
STATIC_DIR=../client
  1. Follow the instructions in server/README.md for how to build and/or run the server.

  2. View in the browser: localhost:4242 and test with 4242424242424242.

  3. [Optional] Forward webhook events

You can use the Stripe CLI to forward webhook events to your server running locally.

stripe listen --forward-to localhost:4242/webhook

You should see events logged in the console where the CLI is running.

When you are ready to create a live webhook endpoint, follow our guide in the docs on configuring a webhook endpoint in the dashboard.

Option 2: Installing manually

If you do not want to use the Stripe CLI, you can manually clone and configure the sample:

  1. Clone the repository
git clone [email protected]:stripe-samples/subscription-use-cases.git
cd subscription-use-cases
  1. Configure .env

The .env file contains the API keys and some settings to enable the sample to run with data for your Stripe account.

Copy the .env.example file from the root of the project into a file named .env in the folder of the server language you want to use. For example with node:

cp .env.example fixed-price-subscriptions/server/node/.env
cd fixed-price-subscriptions/server/node

For example with ruby:

cp .env.example fixed-price-subscriptions/server/ruby/.env
cd fixed-price-subscriptions/server/ruby
  1. Edit the copied .env and populate all of the variables. For more information see: .env config
# Stripe keys
STRIPE_PUBLISHABLE_KEY=pk_12345
STRIPE_SECRET_KEY=sk_12345
STRIPE_WEBHOOK_SECRET=whsec_1234

# Stripe key for React front end
REACT_APP_STRIPE_PUBLISHABLE_KEY=pk_12345

# Billing variables
BASIC=price_12345...
PREMIUM=price_7890...

# Environment variables
STATIC_DIR=../../client/vanillajs
  1. Follow the server instructions on how to run:

Pick the server language you want and follow the instructions in the server folder README on how to run.

cd fixed-price-subscriptions/server/node # there's a README in this folder with instructions
npm install
npm start
  1. [Optional] Forward webhook events

You can use the Stripe CLI to forward webhook events to your server running locally.

If you haven't already, install the CLI and link your Stripe account.

stripe listen --forward-to localhost:4242/webhook

You should see events logged in the console where the CLI is running.

When you are ready to create a live webhook endpoint, follow our guide in the docs on configuring a webhook endpoint in the dashboard.

How to create Prices

With Stripe CLI Fixtures

Use the seed.json fixture file:

stripe fixtures seed.json

With Stripe CLI API calls

Or run the following commands and copy the resulting IDs.

stripe prices create --unit-amount 500 --currency usd -d "recurring[interval]=month" -d "product_data[name]=basic" --lookup-key sample_basic
stripe prices create --unit-amount 900 --currency usd -d "recurring[interval]=month" -d "product_data[name]=premium" --lookup-key sample_premium

With cURL

Replace sk_test_xxx with your secret API key:

curl https://api.stripe.com/v1/prices \
  -u sk_test_xxx: \
  -d "unit_amount"=500 \
  -d "currency"=usd \
  -d "recurring[interval]"=month \
  -d "product_data[name]"=basic \
  -d "lookup_key"=sample_basic \
curl https://api.stripe.com/v1/prices \
  -u sk_test_xxx: \
  -d "unit_amount"=900 \
  -d "currency"=usd \
  -d "recurring[interval]"=month \
  -d "product_data[name]"=premium \
  -d "lookup_key"=sample_premium \

.env config

Example configuration file .env.example

FAQ

Q: Why did you pick these frameworks?

A: We chose the most minimal framework to convey the key Stripe calls and concepts you need to understand. These demos are meant as an educational tool that helps you roadmap how to integrate Stripe within your own system independent of the framework.

Get support

If you found a bug or want to suggest a new [feature/use case/sample], please file an issue.

If you have questions, comments, or need help with code, we're here to help:

Sign up to stay updated with developer news.

Author(s)

Contributors

Made with contrib.rocks.

More Repositories

1

checkout-one-time-payments

Use Checkout to quickly collect one-time payments.
CSS
846
star
2

checkout-single-subscription

Learn how to combine Checkout and Billing for fast subscription pages
CSS
742
star
3

accept-a-payment

Learn how to accept a payment from customers around the world with a variety of payment methods.
JavaScript
640
star
4

firebase-subscription-payments

Example web client for the `firestore-stripe-subscriptions` Firebase Extension using Stripe Checkout and the Stripe Customer Portal.
JavaScript
288
star
5

github-pages-stripe-checkout

Example of a client-only (no server) donation payment page that can be hosted on GitHub using Stripe Checkout.
CSS
171
star
6

saving-card-without-payment

How to build a form to save a credit card without taking a payment.
Ruby
126
star
7

netlify-stripe-subscriptions

An example of managing subscriptions with the Stripe Customer Portal and Netlify Identity.
HTML
125
star
8

connect-onboarding-for-standard

Stripe Sample to show you how to use Connect Onboarding for Standard for seamless user on-boarding with Stripe Connect.
CSS
112
star
9

checkout-netlify-serverless

Sell products on the Jamstack with Netlify Functions and Stripe Checkout!
HTML
95
star
10

saving-card-after-payment

Learn how to save a card for later reuse after making a payment
CSS
79
star
11

issuing-treasury

Learn the building blocks for working with Stripe Issuing and Treasury APIs.
TypeScript
78
star
12

stripe-node-cloudflare-worker-template

Use stripe-node in a Cloudflare Worker.
JavaScript
77
star
13

placing-a-hold

Learn how to place a hold on a credit card (split auth / capture)
CSS
62
star
14

sample-store-android

Learn how to add a simple checkout flow to your Android app
Kotlin
48
star
15

charging-a-saved-card

Learn how to charge a saved card and handle failures
JavaScript
41
star
16

subscriptions-with-card-and-direct-debit

A Stripe sample implementing card and direct debit methods for usage with subscriptions.
JavaScript
39
star
17

identity

Verify your users' identity documents
CSS
37
star
18

connect-onboarding-for-express

Stripe Sample to show you how to use Connect Onboarding for Express for seamless user on-boarding with Stripe Connect.
CSS
35
star
19

mobile-saving-card-without-payment

Learn how to save a credit card without taking a payment on iOS & Android
Java
26
star
20

connect-direct-charge-checkout

Accept a payment with direct charges and Checkout
CSS
26
star
21

react-elements-netlify-serverless

Digital Wallet payments with React Stripe Elements and Netlify Functions
JavaScript
24
star
22

stripe-node-deno-samples

Using stripe-node with Deno.
JavaScript
23
star
23

tap-to-pay-android-demo

A demo app of Tap to Pay with Stripe on Android
Kotlin
19
star
24

wechatpay-sources-android

WeChat Pay Payments with Sources API on Android
Kotlin
18
star
25

connect-express-oauth

Create an Express account with OAuth.
CSS
17
star
26

connect-destination-charge

Accept a payment with destination charges.
JavaScript
17
star
27

link

Demo for accepting payments with Link
CSS
17
star
28

connect-direct-charge

Accept a payment with direct charges.
JavaScript
14
star
29

connect-top-up-and-transfer

Top-up your platform's balance and pay out connected accounts.
JavaScript
14
star
30

samples-list

This is a directory of Stripe Samples used by the Stripe CLI
14
star
31

card-payment-charges-api

Accept card payments with the Charges API
CSS
12
star
32

issuing

Learn how to integrate Stripe Issuing to process real-time authorizations.
CSS
11
star
33

connect-destination-charge-checkout

Accept a payment with destination charges and Checkout.
JavaScript
11
star
34

connect-standard-oauth

Create a Standard account with OAuth.
CSS
10
star
35

terminal

Learn how to accept in-person payments from customers using Stripe Terminal.
CSS
10
star
36

terminal-apps-on-devices

Kotlin
10
star
37

starter

Base sample for tutorials and Stripe Samples
CSS
9
star
38

oasis-hubs-dotnet

Sample application showing a Stripe Connect and Billing integration using ASP.NET Core
HTML
9
star
39

test-data

Quickly generate test data for your Stripe integration with the CLI
7
star
40

stripe-terminal-collect-payments

Companion repo for Stripe Developers episode on collecting payments with Stripe Terminal.
CSS
7
star
41

stripe-terminal-list-readers

Companion repo for Stripe Developers episode on listing readers.
CSS
6
star
42

checkout-uk-bacs-debit-setup-and-payment

CSS
6
star
43

card-brand-choice

Supporting Card Brand Choice with Stripe
Kotlin
6
star
44

commercetools-stripe-example-site

commercetools-stripe-example-site provides an example e-commerce site integrating between the Stripe and commercetools. Topics Resources
JavaScript
5
star
45

checkout-uk-bacs-debit-setup

CSS
3
star
46

stripe-terminal-cancel-actions

Companion repo for Stripe Developers episode on canceling Terminal Reader actions
CSS
3
star
47

sample-ci

Repository for abstracting the CI/CD and GitHub action utilities testing Stripe Samples
Ruby
2
star
48

checkout-foundations-ruby

This repo corresponds to the code shown in the Checkout Foundations video series
Ruby
1
star
49

push-provisioning-samples

Sample apps to give Issuing users a pre-certified foundation for developing their own push provisioning apps
Kotlin
1
star