@stravigor/cashier 0.4.4 → 0.4.5

package/README.md

@@ -0,0 +1,71 @@
+# @stravigor/cashier
+
+Stripe billing for the [Strav](https://www.npmjs.com/package/@stravigor/core) framework. Subscriptions, one-time charges, checkout sessions, invoices, payment methods, and webhooks.
+
+## Install
+
+```bash
+bun add @stravigor/cashier
+bun strav package:install cashier
+```
+
+Requires `@stravigor/core` as a peer dependency.
+
+## Setup
+
+```ts
+import { CashierProvider } from '@stravigor/cashier'
+
+app.use(new CashierProvider())
+```
+
+## Usage
+
+```ts
+import { cashier } from '@stravigor/cashier'
+
+// Create a customer
+const customer = await cashier.createCustomer(user)
+
+// Start a subscription
+const subscription = await cashier
+  .newSubscription('default', 'price_xxx')
+  .create(user)
+
+// Checkout session
+const checkout = await cashier
+  .checkout(user, 'price_xxx')
+  .successUrl('/success')
+  .cancelUrl('/cancel')
+  .create()
+```
+
+## Billable Mixin
+
+```ts
+import { billable } from '@stravigor/cashier'
+
+class User extends billable(BaseModel) {
+  // adds subscription, invoice, and payment helpers
+}
+```
+
+## Webhooks
+
+```ts
+import { stripeWebhook, onWebhookEvent } from '@stravigor/cashier'
+
+onWebhookEvent('customer.subscription.updated', async (event) => {
+  // handle subscription changes
+})
+
+router.post('/stripe/webhook', stripeWebhook())
+```
+
+## Documentation
+
+See the full [Cashier guide](../../guides/cashier.md).
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stravigor/cashier",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "type": "module",
   "description": "Stripe billing for the Strav framework",
   "license": "MIT",
@@ -15,7 +15,7 @@
     "tsconfig.json"
   ],
   "peerDependencies": {
-    "@stravigor/core": "0.4.3"
+    "@stravigor/core": "0.4.4"
   },
   "dependencies": {
     "stripe": "^17.4.0"