• Stars
    star
    742
  • Rank 61,120 (Top 2 %)
  • Language
    CSS
  • License
    MIT License
  • Created about 5 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

Learn how to combine Checkout and Billing for fast subscription pages

Using Checkout for subscriptions

Checkout is a pre-built payment page that lets you accept cards and Apple Pay. Billing is a suite of APIs that lets you model complex subscription plans. You can combine the two products to get a subscription payment page up and running without the need of a server.

When your customer is ready to pay, use Stripe.js with the ID of your Checkout Session to redirect them to your Checkout page.

A gif of the Checkout payment page rendering

Demo

See the sample of the integration live or fork the Node implementation on CodeSandbox.

The demo is 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 testing on Stripe at https://stripe.com/docs/testing.

Features:

  • Localization in over 25 different languages 🌍
  • Built-in Apple Pay support 🍎
  • Built-in dynamic 3D Secure (ready for SCA) πŸ””

For more features see the Checkout documentation.

The integration uses the Checkout Sessions API for additional functionality.

main
πŸ”¨ Prebuilt checkout page. Create a payment page that is customizable with your business' name and logo. βœ…
πŸ–₯️ Define prices in Dashboard or via API. Create a price with either the Stripe Dashboard or API. βœ…
πŸ”’ Start subscription for an existing Customer. Use Customers to keep track of additional customer data. βœ…

How to run locally

This sample includes 8 server implementations in Node, Ruby, Python, Java, PHP, PHP with Slim, Go and .NET.

Follow the steps below to run locally.

1. Clone and configure the sample

The Stripe CLI is the fastest way to clone and configure a sample to run locally.

Cloning using the Stripe CLI

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

In your terminal shell, run the Stripe CLI command to clone the sample:

./stripe samples create checkout-single-subscription

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

Cloning manually

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

git clone https://github.com/stripe-samples/checkout-single-subscription

Copy the .env.example file into a file named .env in the folder of the server you want to use. For example:

cp .env.example server/node/.env

You will need a Stripe account in order to run the demo. Once you set up your account, go to the Stripe developer dashboard to find your API keys.

STRIPE_PUBLISHABLE_KEY=<replace-with-your-publishable-key>
STRIPE_SECRET_KEY=<replace-with-your-secret-key>

2. Create Products and Prices on Stripe

This sample requires two Price IDs to create the Checkout page. Products and Prices are objects on Stripe that let you model a subscription.

Using the Stripe CLI

Create basic product

./stripe products create --name="Basic" --description="Basic plan"

Create premium product

./stripe products create --name="Premium" --description="Premium plan"

Take note of the id value for the products you just created as you will need this to create prices. For example:

{
  "id": "prod_RANDOM_ID_VALUE"
}

Create price for Basic product, substituting ID_OF_BASIC_PRODUCT with the appropriate product Id:

./stripe prices create
  -d "product=ID_OF_BASIC_PRODUCT"
  -d "unit_amount=1800"
  -d "currency=usd"
  -d "recurring[interval]=month"

Create price for Premium product, substituting ID_OF_BASIC_PRODUCT with the appropriate product Id:

./stripe prices create
  -d "product=ID_OF_PREMIUM_PRODUCT"
  -d "unit_amount=1800"
  -d "currency=usd"
  -d "recurring[interval]=month"
With Stripe Tax Stripe Tax lets you calculate and collect sales tax, VAT and GST with one line of code.

Before creating a price, make sure you have Stripe Tax set up in the dashboard: Docs - Set up Stripe Tax.

Stripe needs to know what kind of product you are selling to calculate the taxes. For this example we will submit a tax code describing what kind of product is used: txcd_10000000 which is 'General - Electronically Supplied Services'. You can find a list of all tax codes here: Available tax codes. If you leave the tax code empty, Stripe will use the default one from your Tax settings.

./stripe products create
  -d "name=Premium"
  -d "description=Premium plan"
  -d "tax_code=txcd_10000000"

From the response, copy the id and create a price. The tax behavior can be either inclusive or exclusive. For our example, we are using exclusive.

./stripe prices create
  -d "unit_amount=1800"
  -d "currency=usd"
  -d "tax_behavior=exclusive"
  -d "recurring[interval]=month"
  -d "product=<INSERT_ID, like prod_ABC123>"

More Information: Docs - Update your Products and Prices

Using the Dashboard

You can create Products and Prices in the dashboard. Create two recurring Prices to run this sample.

Update BASIC_PRICE_ID and PRO_PRICE_ID in your .env file

Repeat these steps for to create a second product and price.

Next, open .env in the folder of the server you want to use, and update the values for BASIC_PRICE_ID and PRO_PRICE_ID with the price IDs of the two prices you added.

3. Confirm that you have set the account name

In order to use Checkout, you must set an account or business name at https://dashboard.stripe.com/account

4. 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.

For example, if you want to run the Node server:

cd server/node
# There's a README in this folder with instructions to run the server and how to enable Stripe Tax.
npm install
npm start

[Optional] Customize your branding

To customize your icon, logo and colors for Checkout and the Customer Portal, go to Branding settings in the Dashboard.

[Optional] Run a webhook locally:

You can use the Stripe CLI to easily spin up a local webhook.

First install the CLI and link your Stripe account.

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

The CLI will print a webhook secret key to the console. Set STRIPE_WEBHOOK_SECRET to this value in your .env file.

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.

[Optional] Adjust other environment variables

The other environment variables are configurable:

STATIC_DIR tells the server where to the client files are located and does not need to be modified unless you move the server files.

DOMAIN is the domain of your website, where Checkout will redirect back to after the customer completes the payment on the Checkout page.

FAQ

Q: Why did you pick these frameworks?

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.

Q: What happened to Plans and SKUs?

Plans and SKUs were old ways to model recurring and one-off prices. We created the Prices API to unify the two concepts and make it easier to reason about your pricing catalog. You can still pass old Plan and SKU IDs to Checkout -- to learn more read our docs but know that you do not need to migrate any of your existing SKUs and Plans.

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)

@adreyfus-stripe @cjavilla-stripe

More Repositories

1

checkout-one-time-payments

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

subscription-use-cases

Create subscriptions with fixed prices or usage based billing.
JavaScript
790
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