Giter Club home page Giter Club logo

thunder's Introduction

⚡ Thunder

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. 📦

🚀 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 [email protected] instead of using the issue tracker.

🎉 Credits

thunder's People

Contributors

dependabot[bot] avatar rennokki avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

chronograph

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.