renoki-co/thunder

Thunder is an advanced Laravel tool to track user consumption using Cashier's Metered Billing for Stripe. ⚡

Fund package maintenance!
rennokki

0.2.0 2021-11-09 06:12 UTC

This package is auto-updated.

Last update: 2022-01-25 11:59:07 UTC


README

CI codecov StyleCI Latest Stable Version Total Downloads Monthly Downloads License

Thunder is an advanced Laravel tool to track user consumption using Cashier's Metered Billing for Stripe. ⚡

🤝 Supporting

If you are using one or more Renoki Co. open-source packages in your production apps, in presentation demos, hobby projects, school projects or so, sponsor our work with Github Sponsors. 📦

68747470733a2f2f6769746875622d636f6e74656e742e73332e66722d7061722e7363772e636c6f75642f7374617469632f34352e6a7067

🚀 Installation

You can install the package via composer:

composer require renoki-co/thunder

This project comes with Cashier, and it's really important to install it before diving in the documentation.

🙌 Usage

Thunder tracks resources quotas for your users via Stripe Metered Billing.

You may only define plans with certain features that are connected to Stripe by IDs, declaring them only once throughout your code.

Reporting the usages is done with the IDs you define instead of unique pricing IDs that are different for each environment your deploy your app in, making it consistent throughout the code.

This way, you can call usage reports just like Cashier's Metered Billing, but instead of using the Stripe IDs, you are using the defined IDs:

use RenokiCo\Thunder\Thunder;

Thunder::plan('Unlimited Plan', 'stripe_product_id', [
    Thunder::meteredFeature('Build Minutes', 'build.minutes', 'stripe_build_minutes_price_id'),
    Thunder::meteredFeature('Seats', 'seats', 'stripe_seats_price_id'),
]);

$subscription = $user->subscription('main');

Thunder::reportUsageFor('build.minutes', $subscription, 50);
Thunder::reportUsageFor('build.minutes', $subscription, 100);

Thunder::usage('build.minutes', $subscription); // 150

🐛 Testing

vendor/bin/phpunit

🤝 Contributing

Please see CONTRIBUTING for details.

🔒 Security

If you discover any security related issues, please email alex@renoki.org instead of using the issue tracker.

🎉 Credits