refactor(clerk-js): Move credit out of proration object (#5849)

Author: octoper

.changeset/all-tigers-learn.md

@@ -0,0 +1,6 @@
+---
+'@clerk/clerk-js': patch
+'@clerk/types': patch
+---
+
+Move `credit` at the top-level and remove `proration` property

packages/clerk-js/src/ui/components/Checkout/CheckoutForm.tsx

@@ -31,8 +31,7 @@ export const CheckoutForm = ({
   onCheckoutComplete: (checkout: CommerceCheckoutResource) => void;
 }) => {
   const { plan, planPeriod, totals, isImmediatePlanChange } = checkout;
-  const showCredits =
-    totals.totalDueNow.amount > 0 && !!totals.proration?.credit?.amount && totals.proration.credit.amount > 0;
+  const showCredits = !!totals.credit?.amount && totals.credit.amount > 0;
   const showDowngradeInfo = !isImmediatePlanChange;
 
   return (
@@ -69,9 +68,7 @@ export const CheckoutForm = ({
               <LineItems.Title title={'Credit for the remainder of your current subscription.'} />
               {/* TODO(@Commerce): needs localization */}
               {/* TODO(@Commerce): Replace client-side calculation with server-side calculation once data are available in the response */}
-              <LineItems.Description
-                text={`- ${totals.proration?.credit.currencySymbol}${totals.proration?.credit.amountFormatted}`}
-              />
+              <LineItems.Description text={`- ${totals.credit?.currencySymbol}${totals.credit?.amountFormatted}`} />
             </LineItems.Group>
           )}
           <LineItems.Group borderTop>

packages/clerk-js/src/utils/commerce.ts

@@ -26,12 +26,9 @@ export const commerceTotalsFromJSON = <T extends CommerceInvoiceTotalsJSON | Com
     // @ts-ignore
     totals['totalDueNow'] = commerceMoneyFromJSON(data.total_due_now);
   }
-  if ('proration' in data) {
+  if ('credit' in data) {
     // @ts-ignore
-    totals['proration'] = {
-      // @ts-ignore
-      credit: commerceMoneyFromJSON(data.proration.credit),
-    };
+    totals['credit'] = commerceMoneyFromJSON(data.credit);
   }
 
   return totals as T extends { total_due_now: CommerceMoneyJSON } ? CommerceCheckoutTotals : CommerceInvoiceTotals;

packages/types/src/commerce.ts

@@ -141,9 +141,7 @@ export interface CommerceCheckoutTotals {
   grandTotal: CommerceMoney;
   taxTotal: CommerceMoney;
   totalDueNow: CommerceMoney;
-  proration?: {
-    credit: CommerceMoney;
-  };
+  credit: CommerceMoney;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type

packages/types/src/json.ts

@@ -673,11 +673,7 @@ export interface CommerceCheckoutTotalsJSON {
   subtotal: CommerceMoneyJSON;
   tax_total: CommerceMoneyJSON;
   total_due_now: CommerceMoneyJSON;
-  proration?: {
-    days: number;
-    rate_per_day: CommerceMoneyJSON;
-    total_proration: CommerceMoneyJSON;
-  };
+  credit: CommerceMoneyJSON;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type