Starting a subscription with Checkout
There are several ways you can collect card details and use them to start a subscription on Stripe.
This sample uses Checkout, Stripe's prebuilt payment page to collect card details from a customer which then automatically subscribes them to a subscription plan using the Billing APIs.
Checkout offers a subset of Billing functionality. If you require more control over the UI or subscription model you should check out the sample on setting up subscription with Elements. A comparison table of the two integrations:
|Checkout (this sample)||Elements (set-up-subscriptions)|
|Prebuilt hosted payment page with options to customize limited pieces like the business logo and submit button text||Prebuilt, extremely customizable HTML input elements that securely collect card number, CVC, and exp date and are extremely customizable|
|Built in, no extra code needed||Requires extra code|
|Does not support coupons||Supports coupons|
The hosted demo is running in test mode -- use
4242424242424242 as a test card number with any CVC + future expiration date.
4000000000003220 test card number to trigger a 3D Secure challenge flow.
Read more about test cards on Stripe at https://stripe.com/docs/testing.
How to run locally
This sample includes 5 server implementations in Node, Ruby, Python, Java, and PHP.
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.
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-subscription-and-add-on
The CLI will walk you through picking your integration type, server and client languages, and configuring your .env config file with your Stripe API keys.
Installing and 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-subscription-and-add-on
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 client-and-server/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.
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.
SUBSCRIPTION_PLAN_ID requires a Plan ID for a subscription.
DOMAIN is the domain of your website, where Checkout will redirect back to after the customer completes the payment on the Checkout page.
2. Create Products and Plans on Stripe
This sample requires a Plan ID to create the Checkout page. Products and Plans are objects on Stripe that lets you model a subscription.
3. 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 npm install npm start
5. [Optional] Run a webhook locally:
You can use the Stripe CLI to easily spin up a local webhook.
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.
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.
Q: Can you show me how to build X?
A: We are always looking for new recipe ideas, please email email@example.com with your suggestion!