Use Checkout to quickly collect one-time payments.
Building payment form UI from scratch is difficult -- input field validation, error message handing, and localization are just a few things to think about when designing a simple checkout flow.
We built Checkout to do that work for you so now you can focus on building the best storefront experience for your customers.
Once your customer is ready to pay, use Stripe.js to redirect them to the URL of your Stripe hosted payment page. It's so simple you don't even need a server! 🥳
The demo is running in test mode -- use
4242424242424242as a test card number with any CVC + future expiration date.
4000002500003155test card number to trigger a 3D Secure challenge flow.
Read more about testing on Stripe at https://stripe.com/docs/testing.
For more features see the Checkout documentation.
| | main :--- | :---: 🔨 Prebuilt checkout page. Create a payment page that is customizable with your business' name and logo. | ✅ | 🔢 Dynamic checkout amounts. Dynamically define product amounts rather than relying on predefined Prices. | ✅ | ⌛ Capture payments later. Optionally split the capture and authorization steps to place a hold on the card and charge later. | ✅ |
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-one-time-payments
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-one-time-payments
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_DIRtells the server where to the client files are located and does not need to be modified unless you move the server files.
PRICEis the Price for your product. A Price has a unit amount and currency.
DOMAINis the domain of your website, where Checkout will redirect back to after the customer completes the payment on the Checkout page.
2. 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 client-and-server/server/node # there's a README in this folder with instructions npm install npm start
3. [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_SECRETto 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: What happened to Plans and SKUs?
A: 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.
If you found a bug or want to suggest a new [feature/use case/sample], please file an issue.