Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stripe-samples/checkout-single-subscription
Learn how to combine Checkout and Billing for fast subscription pages
https://github.com/stripe-samples/checkout-single-subscription
stripe stripe-billing stripe-checkout
Last synced: about 2 months ago
JSON representation
Learn how to combine Checkout and Billing for fast subscription pages
- Host: GitHub
- URL: https://github.com/stripe-samples/checkout-single-subscription
- Owner: stripe-samples
- License: mit
- Created: 2019-08-27T17:01:44.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T09:42:50.000Z (about 2 months ago)
- Last Synced: 2024-08-01T10:57:02.145Z (about 2 months ago)
- Topics: stripe, stripe-billing, stripe-checkout
- Language: CSS
- Homepage: https://checkout.stripe.dev/?mode=subscription
- Size: 5.41 MB
- Stars: 726
- Watchers: 15
- Forks: 332
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Using Checkout for subscriptions
[Checkout](https://stripe.com/docs/payments/checkout) is a pre-built payment page that lets you accept cards and Apple Pay. [Billing](https://stripe.com/docs/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](https://stripe.com/docs/js) with the ID of your [Checkout Session](https://stripe.com/docs/api/checkout/sessions/object) to redirect them to your Checkout page.
**Demo**
See the sample of the integration [live](https://u5n7k.sse.codesandbox.io/) or [fork](https://codesandbox.io/s/github/stripe-samples/checkout-single-subscription/tree/codesandbox) 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](https://stripe.com/docs/payments/checkout/subscriptions).
The integration uses the [Checkout Sessions API](https://stripe.com/docs/api/checkout/sessions) 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](https://stripe.com/docs/api/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](https://stripe.com/docs/stripe-cli#install) 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:
>
> ```sh
> ./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:
>
> ```sh
> 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:
>
> ```sh
> 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](https://stripe.com/docs/development/quickstart#api-keys) to find your API keys.
>
> ```sh
> STRIPE_PUBLISHABLE_KEY=
> STRIPE_SECRET_KEY=
> ```
**2. Create Products and Prices on Stripe**
This sample requires two [Price](https://stripe.com/docs/api/prices/object) 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
```sh
./stripe products create --name="Basic" --description="Basic plan"
```
Create premium product
```sh
./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:
```json
{
"id": "prod_RANDOM_ID_VALUE"
}
```
Create price for Basic product, substituting `ID_OF_BASIC_PRODUCT` with the appropriate product Id:
```sh
./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:
```sh
./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](https://stripe.com/docs/tax/set-up).
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](https://stripe.com/docs/tax/tax-codes). If you leave the tax code empty, Stripe will use the default one from your [Tax settings](https://dashboard.stripe.com/test/settings/tax).
```sh
./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`.
```sh
./stripe prices create \
-d "unit_amount=1800" \
-d "currency=usd" \
-d "tax_behavior=exclusive" \
-d "recurring[interval]=month" \
-d "product="
```
More Information: [Docs - Update your Products and Prices](https://stripe.com/docs/tax/checkout#product-and-price-setup)
**Using the Dashboard**
You can create Products and Prices [in the dashboard](https://dashboard.stripe.com/products). 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:
```sh
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](https://dashboard.stripe.com/account/branding) 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](https://stripe.com/docs/stripe-cli) and [link your Stripe account](https://stripe.com/docs/stripe-cli#link-account).
```sh
./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](https://stripe.com/docs/webhooks/setup#configure-webhook-settings).
**[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](https://stripe.com/docs/payments/checkout/migrating-prices) 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](../../issues).
If you have questions, comments, or need help with code, we're here to help:
- on [Discord](https://stripe.com/go/developer-chat)
- on Twitter at [@StripeDev](https://twitter.com/StripeDev)
- on Stack Overflow at the [stripe-payments](https://stackoverflow.com/tags/stripe-payments/info) tag
- by [email](mailto:[email protected])
Sign up to [stay updated with developer news](https://go.stripe.global/dev-digest).
## Author(s)
[@adreyfus-stripe](https://twitter.com/adrind)
[@cjavilla-stripe](https://twitter.com/cjav_dev)