Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jbelien/stripe-api
https://github.com/jbelien/stripe-api
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jbelien/stripe-api
- Owner: jbelien
- License: gpl-3.0
- Created: 2019-11-24T19:24:04.000Z (about 5 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-03-01T14:23:06.000Z (10 months ago)
- Last Synced: 2024-04-15T00:02:41.144Z (8 months ago)
- Language: PHP
- Homepage:
- Size: 279 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stripe API
**Compatible with [Stripe API version `2022-11-15`](https://stripe.com/docs/upgrades#2022-11-15)**
## Configuration
File: `src/.env` (you can copy-paste content of `src/.env.example`)
- `APP_DEBUG` - Debug mode (`true` or `false`)
- `STRIPE_SECRET_KEY` - Stripe secret key (should start with `sk_live_`) ; see [API keys](https://dashboard.stripe.com/apikeys)
If you want to use Stripe Connect, you should also set these variables:
- `STRIPE_SECRET_KEY` - Stripe secret key for the "parent" account (should start with `sk_live_`) ; see [API keys](https://dashboard.stripe.com/apikeys)
- `STRIPE_CONNECTED_ACCOUNT` - Stripe account ID of the "child" account (should start with `acct_`) ; see [settings](https://dashboard.stripe.com/settings/account)
- `FEE_PERCENTAGE` - Fee percentage (e.g. `0.10` for 10%)
## Usage
### Create checkout session
Documentation:
#### Subscription mode
```http
POST /checkout/session/subscription
```
| Parameter | Required | Description |
|------------|--------------|-------------------------------------------------------------------------------------------------------|
| successUrl | **required** | The URL to which Stripe should send customers when payment or setup is complete. |
| cancelUrl | **required** | The URL the customer will be directed to if they decide to cancel payment and return to your website. |
| plan | **required** | [Plan ID](https://stripe.com/docs/api/plans) for this item. |
| locale | (optional) | The IETF language tag of the locale Checkout is displayed in. |
> **Note**
> If you're upgrading from version 1.x, you must use `subscription` instead of `plan` in the request URL.
#### Payment mode
```http
POST /checkout/session/payment
```
| Parameter | Required | Description |
|------------|--------------|-------------------------------------------------------------------------------------------------------|
| successUrl | **required** | The URL to which Stripe should send customers when payment or setup is complete. |
| cancelUrl | **required** | The URL the customer will be directed to if they decide to cancel payment and return to your website. |
| amount | **required** | The amount to be collected per unit of the line item. |
| currency | **required** | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. |
| message | (optional) | The description for the line item, to be displayed on the Checkout page. |
| locale | (optional) | The IETF language tag of the locale Checkout is displayed in. |
> **Note**
> If you're upgrading from version 1.x, you must use `payment` instead of `donation` in the request URL.