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

package/src/types.ts

@@ -154,9 +154,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
@@ -257,6 +274,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
 	 *

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,26 @@ 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);
+}