Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oixan/cashier-connect
Stripe Connect for Laravel Cashier ( Laravel stripe connect )
https://github.com/oixan/cashier-connect
Last synced: about 2 months ago
JSON representation
Stripe Connect for Laravel Cashier ( Laravel stripe connect )
- Host: GitHub
- URL: https://github.com/oixan/cashier-connect
- Owner: oixan
- License: mit
- Created: 2019-03-23T13:17:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-01T19:26:05.000Z (over 2 years ago)
- Last Synced: 2024-04-09T10:49:25.413Z (9 months ago)
- Language: PHP
- Homepage:
- Size: 95.7 KB
- Stars: 22
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Introduction
Laravel Cashier Connect add support for Stripe Connect Subscription to laravel Cashier (based on v10.7.1).
# Documentation
1) Install the package
```
composer require "oixan/cashier-connect"
```
2) Follow the instructions of cashier in the [official guide](https://laravel.com/docs/7.x/billing#configuration "Instructions")
The installations process is the same.
3) Add the Trait to User model
```use Billable``` from ```use Laravel\CashierConnect\Billable```
## Create your .env file
You will need to set the Stripe **Testing** Secret env variable before your `vendor/bin/phpunit` call in order to run the Cashier Connect tests:
STRIPE_SECRET=
Please note that due to the fact that actual API requests against Stripe are being made, these tests take a few minutes to run.
## How this package work.
All the default cashier methods remain the same if not direct support by CashierConnect.
This package assume you created yours Stripe Accounts directly or through API then assign the Account id to **user->stripe_account_id**.
Every user can be a customers or an Stripe Account.
## Basic Method Added to User model
```
$user = user from db or wathever;
$user->getStripeAccount(); // Check if every cashier call will go to Stripe Account
$user->setStripeAccount($userAccount); // Pass a User instance then every cashier call will go to Stripe Account
$user->unsetStripeAccount; // Remove the userAccount, cashier will work with default setting.
$user->pauseStripeAccount // Pause the userAccount, cashier will work with default setting.
$user->resumeStripeAccount // Resume the previous userAccount, cashier call will go to Stripe Account
```
*** IMPORTANT *** any further call after setStripeAccount() will be direct to Stripe Account so remember to call unsetStripeAccount() if needed.
## Methods Supported (Version 0.3.0).
The ``` setStripeAccount($userAccount) ``` method make every subsequent call goes from your Platform to Stripe Account passed like parameter. If you need to change the userAccount or pause the StripeAccount call see the previous section.
Creating Subscriptions
```php
$user->setStripeAccount($userAccount)->newSubscription('main', 'plan_id')->create("pm_card_visa");
```
Add user detail
```php
$user->newSubscription('main', 'monthly')->create($token, [
'email' => $email,
]);
```
Checking Subscription Status
```php
if ($user->subscribed('main')) {
//
}
```
Subscribe to plan
```php
if ($user->subscribedToPlan('monthly', 'main')) {
//
}
```
Reccuring check
```php
if ($user->subscription('main')->recurring()) {
//
}
```
Cancelled Subscription Status
```php
if ($user->subscription('main')->cancelled()) {
//
}
if ($user->subscription('main')->onGracePeriod()) {
//
}
if ($user->subscription('main')->ended()) {
//
}
```
Changing Plans
```php
$user->subscription('main')->swap('provider-plan-id');
```
Subscription Quantity
```php
$user->subscription('main')->incrementQuantity();
// Add five to the subscription's current quantity...
$user->subscription('main')->incrementQuantity(5);
$user->subscription('main')->decrementQuantity();
// Subtract five to the subscription's current quantity...
$user->subscription('main')->decrementQuantity(5);
```
Subscription Ancor Date
```php
$user->newSubscription('main', 'premium')
->anchorBillingCycleOn( Carbon::parse('first day of next month'))
->create($token);
```
Subscription Trials
```php
$user->newSubscription('main', 'monthly')
->trialDays(10)
->create($token);
$user->newSubscription('main', 'monthly')
->trialUntil(Carbon::now()->addDays(10))
->create($token);
$user->onTrial('main')
$user->subscription('main')->onTrial()
```
Cancelling Subscriptions
```php
$user->subscription('main')->cancel();
if ($user->subscription('main')->onGracePeriod()) {
//
}
$user->subscription('main')->cancelNow();
```
Resume Subscriptions
```php
$user->subscription('main')->resume();
```
**\*All cashier methods not in list are not tested to work with Stripe Account**
## More.
If you want set an application fee set on user model
```php
public function applicationFeePercent()
{
return 40;
}
```
The Web hook from stripe connect have different secret key. Set
```
services.stripe.webhook.connect_secret
```
to allow cashier connect to accept webhook from stripe connect.
## License
Laravel Cashier Connect is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).