chore(clerk-js,types): Strict type for CommerceCheckout.status

.changeset/nasty-shirts-behave.md

@@ -0,0 +1,6 @@
+---
+'@clerk/clerk-js': minor
+'@clerk/types': minor
+---
+
+[Billing Beta] Update checkout.status type to be `'needs_confirmation' | 'completed'` instead of `string`.

packages/clerk-js/src/core/resources/CommerceCheckout.ts

@@ -18,7 +18,7 @@ export class CommerceCheckout extends BaseResource implements CommerceCheckoutRe
   plan!: CommercePlan;
   planPeriod!: CommerceSubscriptionPlanPeriod;
   planPeriodStart!: number | undefined;
-  status!: string;
+  status!: 'needs_confirmation' | 'completed';
   totals!: CommerceCheckoutTotals;
   isImmediatePlanChange!: boolean;
 

packages/types/src/commerce.ts

@@ -1503,7 +1503,7 @@ export interface CommerceCheckoutResource extends ClerkResource {
    * <ClerkProvider clerkJsVersion="x.x.x" />
    * ```
    */
-  status: string;
+  status: 'needs_confirmation' | 'completed';
   /**
    * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change.
    * It is advised to pin the SDK version and the clerk-js version to a specific version to avoid breaking changes.

packages/types/src/json.ts

@@ -870,7 +870,7 @@ export interface CommerceCheckoutJSON extends ClerkResourceJSON {
   plan: CommercePlanJSON;
   plan_period: CommerceSubscriptionPlanPeriod;
   plan_period_start?: number;
-  status: string;
+  status: 'needs_confirmation' | 'completed';
   totals: CommerceCheckoutTotalsJSON;
   is_immediate_plan_change: boolean;
 }