@deiondz/better-auth-razorpay 2.0.9 → 2.0.11

package/README.md

@@ -63,8 +63,57 @@ The package includes `razorpay` and `zod` as dependencies.
 
 2. **Configure the Plugin**
 
+You can either pass an existing Razorpay instance (`razorpayClient`) or let the plugin create it from credentials (`razorpayKeyId` + `razorpayKeySecret`).
+
+**Option A: Pass credentials (plugin creates the Razorpay instance)**
+
 ```typescript
 // src/lib/auth.ts (or your auth configuration file)
+import { betterAuth } from 'better-auth'
+import { razorpayPlugin } from '@deiondz/better-auth-razorpay'
+
+export const auth = betterAuth({
+  // ... your Better Auth configuration
+  database: mongodbAdapter(await connect()), // or your adapter
+  secret: process.env.BETTER_AUTH_SECRET,
+  baseURL: process.env.BETTER_AUTH_URL,
+  
+  plugins: [
+    razorpayPlugin({
+      razorpayKeyId: process.env.RAZORPAY_KEY_ID!,
+      razorpayKeySecret: process.env.RAZORPAY_KEY_SECRET!, // also enables verify-payment endpoint when set
+      razorpayWebhookSecret: process.env.RAZORPAY_WEBHOOK_SECRET,
+      createCustomerOnSignUp: true, // optional
+      subscription: {
+        enabled: true,
+        plans: [
+          {
+            name: 'Starter',
+            monthlyPlanId: 'plan_xxxxxxxxxxxx',
+            annualPlanId: 'plan_yyyyyyyyyyyy', // optional
+            limits: { features: 5 },
+            freeTrial: { days: 7 }, // optional
+          },
+        ],
+        onSubscriptionActivated: async ({ subscription, plan }) => {
+          console.log(`Subscription ${subscription.id} activated for plan ${plan.name}`)
+        },
+      },
+      onWebhookEvent: async (payload, context) => {
+        const { event, subscription, payment } = payload
+        if (event === 'subscription.charged' && payment) {
+          // Send confirmation email, etc.
+        }
+      },
+    }),
+  ],
+})
+```
+
+**Option B: Pass an existing Razorpay client**
+
+```typescript
+// src/lib/auth.ts
 import Razorpay from 'razorpay'
 import { betterAuth } from 'better-auth'
 import { razorpayPlugin } from '@deiondz/better-auth-razorpay'
@@ -76,7 +125,7 @@ const razorpayClient = new Razorpay({
 
 export const auth = betterAuth({
   // ... your Better Auth configuration
-  database: mongodbAdapter(await connect()), // or your adapter
+  database: mongodbAdapter(await connect()),
   secret: process.env.BETTER_AUTH_SECRET,
   baseURL: process.env.BETTER_AUTH_URL,
   
@@ -165,9 +214,10 @@ npx @better-auth/cli@latest generate
 
 ```typescript
 interface RazorpayPluginOptions {
-  razorpayClient: Razorpay         // Required: Initialized Razorpay instance (key_id, key_secret)
-  razorpayWebhookSecret?: string  // Optional: Webhook secret for signature verification
-  razorpayKeySecret?: string      // Optional: API key secret for payment signature verification; when set, enables POST /razorpay/verify-payment (same secret as Razorpay client, not webhook secret)
+  razorpayClient?: Razorpay       // Optional: Initialized Razorpay instance; omit when using razorpayKeyId + razorpayKeySecret
+  razorpayKeyId?: string          // Optional: Razorpay API key ID; required when razorpayClient is not provided (plugin creates the instance)
+  razorpayKeySecret?: string     // Optional: Razorpay API key secret; required when razorpayClient is not provided; when set, enables POST /razorpay/verify-payment
+  razorpayWebhookSecret?: string // Optional: Webhook secret for signature verification
   createCustomerOnSignUp?: boolean // Optional: Create Razorpay customer on user sign-up (default: false)
   onCustomerCreate?: (args) => Promise<void>
   getCustomerCreateParams?: (args) => Promise<{ params?: Record<string, unknown> }>
@@ -287,7 +337,7 @@ All endpoints are prefixed with `/api/auth/razorpay/` (or your configured `baseP
 
 | Action | Method | Endpoint | Description |
 |--------|--------|----------|-------------|
-| Create or update | `POST` | `subscription/create-or-update` | Start a subscription or update; returns `checkoutUrl` for Razorpay payment page. Body: `plan`, `annual?`, `seats?`, `subscriptionId?`, `successUrl?`, `disableRedirect?`. |
+| Create or update | `POST` | `subscription/create-or-update` | Start a subscription or update; returns `checkoutUrl` for Razorpay payment page. Body: `plan` (plan **name** or Razorpay plan ID `plan_*`), `annual?`, `seats?`, `subscriptionId?`, `successUrl?`, `disableRedirect?`. |
 | Cancel | `POST` | `subscription/cancel` | Cancel by local subscription ID. Body: `subscriptionId`, `immediately?`. |
 | Restore | `POST` | `subscription/restore` | Restore a subscription scheduled to cancel. Body: `subscriptionId`. |
 | List | `GET` | `subscription/list` | List active/trialing subscriptions. Query: `referenceId?` (default: current user). |
@@ -685,6 +735,7 @@ if (plansRes.success) console.log(plansRes.data)
 const listRes = await authClient.razorpay.listSubscriptions({ referenceId: 'optional' })
 
 // Create or update subscription (returns checkoutUrl for Razorpay payment page)
+// plan: use the plan name (e.g. 'Starter') or the Razorpay plan ID (e.g. 'plan_xxxxxxxxxxxx')
 const result = await authClient.razorpay.createOrUpdateSubscription({
   plan: 'Starter',
   annual: false,

package/dist/client/hooks.d.ts

@@ -1,10 +1,10 @@
-import { S as SubscriptionRecord } from '../types-B25gyPpX.js';
+import { S as SubscriptionRecord } from '../types-VZW_XCzQ.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseMutationOptions, UseQueryOptions } from '@tanstack/react-query';
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { c as RazorpayAuthClient, d as CancelSubscriptionResponse, a as CancelSubscriptionInput, e as CreateOrUpdateSubscriptionResponse, C as CreateOrUpdateSubscriptionInput, P as PlanSummary, f as RestoreSubscriptionResponse, b as RestoreSubscriptionInput, g as ListSubscriptionsResponse, h as VerifyPaymentResponse, V as VerifyPaymentInput, L as ListSubscriptionsInput } from '../types-C0_Sreb6.js';
-export { G as GetPlansResponse, i as RazorpayApiError, R as RazorpayApiResult, j as RazorpayClientActions } from '../types-C0_Sreb6.js';
+import { c as RazorpayAuthClient, d as CancelSubscriptionResponse, a as CancelSubscriptionInput, e as CreateOrUpdateSubscriptionResponse, C as CreateOrUpdateSubscriptionInput, P as PlanSummary, f as RestoreSubscriptionResponse, b as RestoreSubscriptionInput, g as ListSubscriptionsResponse, h as VerifyPaymentResponse, V as VerifyPaymentInput, L as ListSubscriptionsInput } from '../types-C2IdKTof.js';
+export { G as GetPlansResponse, i as RazorpayApiError, R as RazorpayApiResult, j as RazorpayClientActions } from '../types-C2IdKTof.js';
 import 'razorpay';
 
 /** Context holding the Razorpay-capable auth client. Default is null. */

package/dist/client.d.ts

@@ -1,6 +1,6 @@
-import { S as SubscriptionRecord } from './types-B25gyPpX.js';
+import { S as SubscriptionRecord } from './types-VZW_XCzQ.js';
 import { razorpayPlugin } from './index.js';
-import { R as RazorpayApiResult, P as PlanSummary, L as ListSubscriptionsInput, C as CreateOrUpdateSubscriptionInput, a as CancelSubscriptionInput, b as RestoreSubscriptionInput, V as VerifyPaymentInput } from './types-C0_Sreb6.js';
+import { R as RazorpayApiResult, P as PlanSummary, L as ListSubscriptionsInput, C as CreateOrUpdateSubscriptionInput, a as CancelSubscriptionInput, b as RestoreSubscriptionInput, V as VerifyPaymentInput } from './types-C2IdKTof.js';
 import 'razorpay';
 import 'better-auth';
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { BetterAuthPlugin } from 'better-auth';
-import { R as RazorpayPluginOptions } from './types-B25gyPpX.js';
-export { O as OnWebhookEventCallback, a as RazorpayApiResponse, b as RazorpayErrorResponse, c as RazorpayPlan, d as RazorpaySubscription, e as RazorpaySuccessResponse, f as RazorpayUserRecord, g as RazorpayWebhookContext, h as RazorpayWebhookEvent, i as RazorpayWebhookPayload, S as SubscriptionRecord, j as SubscriptionStatus } from './types-B25gyPpX.js';
+import { R as RazorpayPluginOptions } from './types-VZW_XCzQ.js';
+export { O as OnWebhookEventCallback, a as RazorpayApiResponse, b as RazorpayErrorResponse, c as RazorpayPlan, d as RazorpaySubscription, e as RazorpaySuccessResponse, f as RazorpayUserRecord, g as RazorpayWebhookContext, h as RazorpayWebhookEvent, i as RazorpayWebhookPayload, S as SubscriptionRecord, j as SubscriptionStatus } from './types-VZW_XCzQ.js';
 import 'razorpay';
 
 interface WebhookResult {
@@ -18,9 +18,10 @@ interface WebhookResult {
  * - Plans: named plans with monthly/annual IDs, limits, free trial
  *
  * @param options - Plugin configuration
- * @param options.razorpayClient - Initialized Razorpay instance (key_id, key_secret)
+ * @param options.razorpayClient - Initialized Razorpay instance (optional; omit when using razorpayKeyId + razorpayKeySecret)
+ * @param options.razorpayKeyId - Razorpay API key ID (required when razorpayClient is not provided; plugin creates the Razorpay instance)
+ * @param options.razorpayKeySecret - Razorpay API key secret (required when razorpayClient is not provided; when set, also enables POST /razorpay/verify-payment)
  * @param options.razorpayWebhookSecret - Webhook secret for signature verification
- * @param options.razorpayKeySecret - API key secret for payment signature verification (optional; when set, enables POST /razorpay/verify-payment)
  * @param options.createCustomerOnSignUp - Create Razorpay customer when user signs up (default: false)
  * @param options.onCustomerCreate - Callback after customer is created
  * @param options.getCustomerCreateParams - Custom params when creating customer

package/dist/index.js

@@ -2,6 +2,9 @@ import {
   __export
 } from "./chunk-PZ5AY32C.js";
 
+// index.ts
+import Razorpay from "razorpay";
+
 // api/cancel-subscription.ts
 import { createAuthEndpoint, sessionMiddleware } from "better-auth/api";
 
@@ -4114,7 +4117,7 @@ function handleRazorpayError(error) {
 
 // lib/schemas.ts
 var createOrUpdateSubscriptionSchema = external_exports.object({
-  plan: external_exports.string().min(1, "Plan name is required"),
+  plan: external_exports.string().min(1, "Plan name or Razorpay plan ID (plan_*) is required"),
   annual: external_exports.boolean().optional().default(false),
   seats: external_exports.number().int().min(1).optional().default(1),
   subscriptionId: external_exports.string().optional(),
@@ -4238,7 +4241,9 @@ var createOrUpdateSubscription = (razorpay, options) => createAuthEndpoint2(
         };
       }
       const plans = await resolvePlans(subOpts.plans);
-      const plan = plans.find((p) => p.name === body.plan);
+      const plan = body.plan.startsWith("plan_") ? plans.find(
+        (p) => p.monthlyPlanId === body.plan || p.annualPlanId === body.plan
+      ) : plans.find((p) => p.name === body.plan);
       if (!plan) {
         return {
           success: false,
@@ -4414,6 +4419,7 @@ var getPlans = (options) => createAuthEndpoint3("/razorpay/get-plans", { method:
         name: p.name,
         monthlyPlanId: p.monthlyPlanId,
         annualPlanId: p.annualPlanId,
+        description: p.description,
         limits: p.limits,
         freeTrial: p.freeTrial ? { days: p.freeTrial.days } : void 0
       }))
@@ -4824,18 +4830,31 @@ async function processWebhookEvent(adapter, rawBody, fallbackBody, onWebhookEven
 var razorpayPlugin = (options) => {
   const {
     razorpayClient,
-    razorpayWebhookSecret,
+    razorpayKeyId,
     razorpayKeySecret,
+    razorpayWebhookSecret,
     createCustomerOnSignUp = false,
     onCustomerCreate,
     getCustomerCreateParams,
     subscription: subOpts,
     onEvent
   } = options;
-  if (!razorpayClient) {
-    throw new Error("Razorpay plugin: razorpayClient is required");
-  }
-  const razorpay = razorpayClient;
+  const hasClient = Boolean(razorpayClient);
+  const hasCredentials = Boolean(razorpayKeyId && razorpayKeySecret);
+  if (!hasClient && !hasCredentials) {
+    throw new Error(
+      "Razorpay plugin: provide either razorpayClient or both razorpayKeyId and razorpayKeySecret"
+    );
+  }
+  if (hasClient && hasCredentials) {
+    throw new Error(
+      "Razorpay plugin: provide either razorpayClient or credentials (razorpayKeyId + razorpayKeySecret), not both"
+    );
+  }
+  if (!hasClient && (typeof razorpayKeyId !== "string" || typeof razorpayKeySecret !== "string")) {
+    throw new Error("Razorpay plugin: both razorpayKeyId and razorpayKeySecret are required when not providing razorpayClient");
+  }
+  const razorpay = razorpayClient ?? new Razorpay({ key_id: razorpayKeyId, key_secret: razorpayKeySecret });
   const plugin = {
     id: "razorpay-plugin",
     schema: {