README for stripe:checkout
Description
This Prog will quickly generate a Stripe Payment Link using the Stripe API.
Requirements
In order to use this, you will need:
- A Stripe account
- An API key with permissions to generate a payment link -- Note: Only generate API keys with restricted permissions
Generating your Stripe API key
In your Stripe dashboard:
- Click on Developers
- Click API Keys
- Under Restricted keys, click Create restricted key
- Under Checkout Sessions, click Write
- Enter a name for this API key so it is identifiable
- Click Create key
- Save the API key shown in a safe place
Usage
proggy run stripe:paylink
When you run the above command, this Prog will ask for your Stripe API key in order to be able to make the POST request to Stripe's API servers.
If you do not want to enter your API key every time, you can use:
proggy run official/stripe:checkout --save-defaults
With the --save-defaults
flag, Proggy will save all responses as "defaults" the next time you run this command so you can just press the key to reuse the same value.
Disclaimers
Use this Prog command at your own risk. Because you are using your own Stripe API key, it is possible you create a Stripe checkout session that has the wrong checkout value (ie. $10 instead of $100) and you send it to your customer. As a result, you may incur charges if you have to refund your customer for a wrong amount.
All POST request calls are made locally from your computer, and so Proggy (the web application) never sees your API key.
We are not responsible for any monetary loss incurred from any use of this Prog command or services provided by Proggy and/or the Proggy CLI tool.
Finally, keep any third-party (ie. Stripe) API keys safe. Never save it in any location where it can be accessed by unauthorized individuals.