@better-auth/stripe 1.5.0-beta.1 → 1.5.0-beta.3

package/src/schema.ts

@@ -46,6 +46,18 @@ export const subscriptions = {
 				required: false,
 				defaultValue: false,
 			},
+			cancelAt: {
+				type: "date",
+				required: false,
+			},
+			canceledAt: {
+				type: "date",
+				required: false,
+			},
+			endedAt: {
+				type: "date",
+				required: false,
+			},
 			seats: {
 				type: "number",
 				required: false,
@@ -65,6 +77,17 @@ export const user = {
 	},
 } satisfies BetterAuthPluginDBSchema;
 
+export const organization = {
+	organization: {
+		fields: {
+			stripeCustomerId: {
+				type: "string",
+				required: false,
+			},
+		},
+	},
+} satisfies BetterAuthPluginDBSchema;
+
 export const getSchema = (options: StripeOptions) => {
 	let baseSchema = {};
 
@@ -79,6 +102,13 @@ export const getSchema = (options: StripeOptions) => {
 		};
 	}
 
+	if (options.organization?.enabled) {
+		baseSchema = {
+			...baseSchema,
+			...organization,
+		};
+	}
+
 	if (
 		options.schema &&
 		!options.subscription?.enabled &&

package/src/types.ts

@@ -4,8 +4,32 @@ import type {
 	Session,
 	User,
 } from "better-auth";
+import type { Organization } from "better-auth/plugins/organization";
 import type Stripe from "stripe";
-import type { subscriptions, user } from "./schema";
+import type { organization, subscriptions, user } from "./schema";
+
+export type AuthorizeReferenceAction =
+	| "upgrade-subscription"
+	| "list-subscription"
+	| "cancel-subscription"
+	| "restore-subscription"
+	| "billing-portal";
+
+export type CustomerType = "user" | "organization";
+
+export type WithStripeCustomerId = {
+	stripeCustomerId?: string;
+};
+
+// TODO: Types extended by a plugin should be moved into that plugin.
+export type WithActiveOrganizationId = {
+	activeOrganizationId?: string;
+};
+
+export type StripeCtxSession = {
+	session: Session & WithActiveOrganizationId;
+	user: User & WithStripeCustomerId;
+};
 
 export type StripePlan = {
 	/**
@@ -154,9 +178,26 @@ export interface Subscription {
 	 */
 	periodEnd?: Date | undefined;
 	/**
-	 * Cancel at period end
+	 * Whether this subscription will (if status=active)
+	 * or did (if status=canceled) cancel at the end of the current billing period.
 	 */
 	cancelAtPeriodEnd?: boolean | undefined;
+	/**
+	 * If the subscription is scheduled to be canceled,
+	 * this is the time at which the cancellation will take effect.
+	 */
+	cancelAt?: Date | undefined;
+	/**
+	 * If the subscription has been canceled, this is the time when it was canceled.
+	 *
+	 * Note: If the subscription was canceled with `cancel_at_period_end`,
+	 * this reflects the cancellation request time, not when the subscription actually ends.
+	 */
+	canceledAt?: Date | undefined;
+	/**
+	 * If the subscription has ended, the date the subscription ended.
+	 */
+	endedAt?: Date | undefined;
 	/**
 	 * A field to group subscriptions so you can have multiple subscriptions
 	 * for one reference id
@@ -236,12 +277,7 @@ export type SubscriptionOptions = {
 					user: User & Record<string, any>;
 					session: Session & Record<string, any>;
 					referenceId: string;
-					action:
-						| "upgrade-subscription"
-						| "list-subscription"
-						| "cancel-subscription"
-						| "restore-subscription"
-						| "billing-portal";
+					action: AuthorizeReferenceAction;
 				},
 				ctx: GenericEndpointContext,
 		  ) => Promise<boolean>)
@@ -257,6 +293,18 @@ export type SubscriptionOptions = {
 				subscription: Subscription;
 		  }) => Promise<void>)
 		| undefined;
+	/**
+	 * A callback to run when a subscription is created
+	 * @returns
+	 */
+	onSubscriptionCreated?:
+		| ((data: {
+				event: Stripe.Event;
+				stripeSubscription: Stripe.Subscription;
+				subscription: Subscription;
+				plan: StripePlan;
+		  }) => Promise<void>)
+		| undefined;
 	/**
 	 * parameters for session create params
 	 *
@@ -284,14 +332,6 @@ export type SubscriptionOptions = {
 						options?: Stripe.RequestOptions;
 				  })
 		| undefined;
-	/**
-	 * Enable organization subscription
-	 */
-	organization?:
-		| {
-				enabled: boolean;
-		  }
-		| undefined;
 };
 
 export interface StripeOptions {
@@ -319,7 +359,7 @@ export interface StripeOptions {
 		| ((
 				data: {
 					stripeCustomer: Stripe.Customer;
-					user: User & { stripeCustomerId: string };
+					user: User & WithStripeCustomerId;
 				},
 				ctx: GenericEndpointContext,
 		  ) => Promise<void>)
@@ -349,6 +389,49 @@ export interface StripeOptions {
 				  } & SubscriptionOptions)
 		  )
 		| undefined;
+	/**
+	 * Organization Stripe integration
+	 *
+	 * Enable organizations to have their own Stripe customer ID
+	 */
+	organization?:
+		| {
+				/**
+				 * Enable organization Stripe customer
+				 */
+				enabled: true;
+				/**
+				 * A custom function to get the customer create params
+				 * for organization customers.
+				 *
+				 * @param organization - the organization
+				 * @param ctx - the context object
+				 * @returns
+				 */
+				getCustomerCreateParams?:
+					| ((
+							organization: Organization,
+							ctx: GenericEndpointContext,
+					  ) => Promise<Partial<Stripe.CustomerCreateParams>>)
+					| undefined;
+				/**
+				 * A callback to run after an organization customer has been created
+				 *
+				 * @param data - data containing stripeCustomer and organization
+				 * @param ctx - the context object
+				 * @returns
+				 */
+				onCustomerCreate?:
+					| ((
+							data: {
+								stripeCustomer: Stripe.Customer;
+								organization: Organization & WithStripeCustomerId;
+							},
+							ctx: GenericEndpointContext,
+					  ) => Promise<void>)
+					| undefined;
+		  }
+		| undefined;
 	/**
 	 * A callback to run after a stripe event is received
 	 * @param event - Stripe Event
@@ -358,7 +441,9 @@ export interface StripeOptions {
 	/**
 	 * Schema for the stripe plugin
 	 */
-	schema?: InferOptionSchema<typeof subscriptions & typeof user> | undefined;
+	schema?:
+		| InferOptionSchema<
+				typeof subscriptions & typeof user & typeof organization
+		  >
+		| undefined;
 }
-
-export interface InputSubscription extends Omit<Subscription, "id"> {}

package/src/utils.ts

@@ -1,4 +1,5 @@
-import type { StripeOptions } from "./types";
+import type Stripe from "stripe";
+import type { StripeOptions, Subscription } from "./types";
 
 export async function getPlans(
 	subscriptionOptions: StripeOptions["subscription"],
@@ -33,3 +34,37 @@ export async function getPlanByName(options: StripeOptions, name: string) {
 		res?.find((plan) => plan.name.toLowerCase() === name.toLowerCase()),
 	);
 }
+
+/**
+ * Checks if a subscription is in an available state (active or trialing)
+ */
+export function isActiveOrTrialing(
+	sub: Subscription | Stripe.Subscription,
+): boolean {
+	return sub.status === "active" || sub.status === "trialing";
+}
+
+/**
+ * Check if a subscription is scheduled to be canceled (DB subscription object)
+ */
+export function isPendingCancel(sub: Subscription): boolean {
+	return !!(sub.cancelAtPeriodEnd || sub.cancelAt);
+}
+
+/**
+ * Check if a Stripe subscription is scheduled to be canceled (Stripe API response)
+ */
+export function isStripePendingCancel(stripeSub: Stripe.Subscription): boolean {
+	return !!(stripeSub.cancel_at_period_end || stripeSub.cancel_at);
+}
+
+/**
+ * Escapes a value for use in Stripe search queries.
+ * Stripe search query uses double quotes for string values,
+ * and double quotes within the value need to be escaped with backslash.
+ *
+ * @see https://docs.stripe.com/search#search-query-language
+ */
+export function escapeStripeSearchValue(value: string): string {
+	return value.replace(/"/g, '\\"');
+}