项目作者: stripe-samples

项目描述 :
Create subscriptions with fixed prices or usage based billing.
高级语言: JavaScript
项目地址: git://github.com/stripe-samples/subscription-use-cases.git
创建时间: 2020-04-27T23:58:15Z
项目社区:https://github.com/stripe-samples/subscription-use-cases

开源协议:MIT License

下载


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:

  1. stripe login
  1. Start the sample installer and follow the prompts with:
  1. 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:
  1. cd subscription-use-cases/server
  1. Open server/.env. The STATIC_DIR value
    should be ../client when installed using the Stripe CLI.
  1. # Stripe keys
  2. STRIPE_PUBLISHABLE_KEY=pk_12345
  3. STRIPE_SECRET_KEY=sk_12345
  4. STRIPE_WEBHOOK_SECRET=whsec_1234
  5. # Stripe key for React front end
  6. VITE_STRIPE_PUBLISHABLE_KEY=pk_12345
  7. # Environment variables
  8. 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.

  1. 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
  1. git clone git@github.com:stripe-samples/subscription-use-cases.git
  2. 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:

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

For example with ruby:

  1. cp .env.example fixed-price-subscriptions/server/ruby/.env
  2. cd fixed-price-subscriptions/server/ruby
  1. Edit the copied .env and populate all of the variables. For more information see: .env config
  1. # Stripe keys
  2. STRIPE_PUBLISHABLE_KEY=pk_12345
  3. STRIPE_SECRET_KEY=sk_12345
  4. STRIPE_WEBHOOK_SECRET=whsec_1234
  5. # Stripe key for React front end
  6. VITE_STRIPE_PUBLISHABLE_KEY=pk_12345
  7. # Billing variables
  8. BASIC=price_12345...
  9. PREMIUM=price_7890...
  10. # Environment variables
  11. 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.

  1. cd fixed-price-subscriptions/server/node # there's a README in this folder with instructions
  2. npm install
  3. 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
.

  1. 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:

  1. stripe fixtures seed.json

With Stripe CLI API calls

Or run the following commands and copy the resulting IDs.

  1. stripe prices create --unit-amount 500 --currency usd -d "recurring[interval]=month" -d "product_data[name]=basic" --lookup-key sample_basic
  1. 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:

  1. curl https://api.stripe.com/v1/prices \
  2. -u sk_test_xxx: \
  3. -d "unit_amount"=500 \
  4. -d "currency"=usd \
  5. -d "recurring[interval]"=month \
  6. -d "product_data[name]"=basic \
  7. -d "lookup_key"=sample_basic \
  1. curl https://api.stripe.com/v1/prices \
  2. -u sk_test_xxx: \
  3. -d "unit_amount"=900 \
  4. -d "currency"=usd \
  5. -d "recurring[interval]"=month \
  6. -d "product_data[name]"=premium \
  7. -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.