@outseta/react 0.4.47 → 0.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@outseta/react",
-  "version": "0.4.47",
+  "version": "0.5.1",
   "description": "React hooks and components for the Outseta API",
   "license": "MIT",
   "repository": {
@@ -18,7 +18,7 @@
     }
   },
   "dependencies": {
-    "@outseta/api-client": "0.3.53"
+    "@outseta/api-client": "0.4.1"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0"

package/src/generated/{billing/billing.ts → billing-v2/billing-v2.ts}

@@ -246,7 +246,11 @@ export function useDiscountCouponGetAllDiscountCoupons<TData = Awaited<ReturnTyp
 
 
 /**
- * Only one of AmountOff or PercentOff should be set.
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3), use coupons and promotion
+codes: POST /billing/stripe/coupons and POST /billing/stripe/promotion-codes. With Stripe
+Billing the request is rejected.
+            
+Only one of AmountOff or PercentOff should be set.
 Duration values: 1 = Forever, 2 = Once, 3 = Repeating (DurationInMonths must be set).
  * @summary Add a new discount coupon.
  */
@@ -380,6 +384,9 @@ export function useDiscountCouponGetDiscountCoupon<TData = Awaited<ReturnType<ty
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3), coupons are managed with
+the /billing/stripe/coupons and /billing/stripe/promotion-codes endpoints. With Stripe
+Billing the request is rejected.
  * @summary Update a discount coupon.
  */
 export const discountCouponUpdateDiscountCoupon = (
@@ -579,6 +586,7 @@ export function useDiscountCouponGetDiscountCouponRedemptions<TData = Awaited<Re
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
  * @summary Add a usage entry for an add-on that bills for usage at the end of the month.
  */
 export const usageAddUsage = (
@@ -917,6 +925,8 @@ export function useSubscriptionAddOnGetAllSubscriptionsAddOns<TData = Awaited<Re
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use PUT /billing/stripe/subscriptions/{subscriptionUid}/change instead.
  * @summary Add an add-on to a subscription.
  */
 export const subscriptionAddOnAddSubscriptionAddOn = (
@@ -1116,7 +1126,9 @@ export const useSubscriptionAddOnAddSubscriptionAddOnPreview = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * When a subscription add-on is flagged, the next time the user authenticates the
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
+            
+When a subscription add-on is flagged, the next time the user authenticates the
 authentication widget will prompt the user to change their add-on.
  * @summary Indicate that an upgrade of an add-on is required.
  */
@@ -1182,7 +1194,10 @@ export const useSubscriptionAddOnSetAddOnUpgradeRequired = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * Removes the add-on from the subscription going forward and returns the updated
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use PUT /billing/stripe/subscriptions/{subscriptionUid}/change instead.
+            
+Removes the add-on from the subscription going forward and returns the updated
 subscription.
  * @summary End an add-on on a subscription.
  */
@@ -1245,6 +1260,7 @@ export const useSubscriptionAddOnEndSubscriptionAddOn = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
  * @summary Immediately ends an add-on.
  */
 export const subscriptionAddOnExpireSubscriptionAddOn = (
@@ -1379,6 +1395,8 @@ export function useInvoiceGetAllInvoices<TData = Awaited<ReturnType<typeof invoi
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use POST /billing/stripe/invoices instead.
  * @summary Create an ad-hoc invoice for a given account.
  */
 export const invoiceAddInvoice = (
@@ -1511,7 +1529,9 @@ export function useInvoiceGetInvoice<TData = Awaited<ReturnType<typeof invoiceGe
 
 
 /**
- * Only invoices created manually via the API or admin UI can be updated; invoices
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
+            
+Only invoices created manually via the API or admin UI can be updated; invoices
 generated by a subscription's billing cycle are immutable and will return a
 validation error.
  * @summary Update an ad-hoc (manually created) invoice.
@@ -2047,6 +2067,7 @@ export const useSubscriptionDeleteSubscription = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
  * @summary Add a discount to a subscription.
  */
 export const subscriptionAddDiscountToSubscription = (
@@ -2175,7 +2196,9 @@ export const useSubscriptionExpireDiscountCouponSubscription = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * When a subscription is flagged, next time the user authenticates the authentication
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected.
+            
+When a subscription is flagged, next time the user authenticates the authentication
 widget will prompt the user to change plan.
  * @summary Indicate that an upgrade of plan is required.
  */
@@ -2311,7 +2334,25 @@ export const useSubscriptionFirstTimeSubscriptionPreview = <TError = unknown,
       return useMutation(mutationOptions);
     }
     /**
- * Returns an invoice object with information about the amount outstanding.
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use POST /billing/stripe/subscriptions instead.
+            
+Returns the new subscription.
+            
+Outseta sets the subscription's dates itself, except ExpirationDate:
+            
+- RenewalDate is calculated from the plan's trial and the BillingRenewalTerm. A value you send is ignored.
+- EndDate is set by Outseta when the subscription ends. Don't send it: a subscription with an EndDate is
+  rejected with "The renewal date has to be null if the end date is set."
+- ExpirationDate gives the subscription a fixed end. Outseta keeps the date you send, doesn't bill past it,
+  and ends the subscription on that date, setting EndDate to it. A free plan with BillingRenewalTerm 1
+  (monthly) renews monthly at no charge until then.
+- Without an ExpirationDate, the plan decides: its ExpirationDate if it has one, otherwise
+  Plan.ExpiresAfterMonths. 0 means the plan never expires subscriptions; a value N above 0 gives an
+  ExpirationDate of the start date plus the plan's trial days plus N months.
+            
+To set or remove the end date of a subscription that already exists, use
+PUT /api/v1/crm/accounts/{accountUid}/extend-renewal.
  * @summary Add a subscription to an account for the first time.
  */
 export const subscriptionFirstTimeSubscription = (
@@ -2319,7 +2360,7 @@ export const subscriptionFirstTimeSubscription = (
  options?: SecondParameter<typeof customFetch>,) => {
       
       
-      return customFetch<Invoice>(
+      return customFetch<Subscription>(
       {url: `/api/v1/billing/subscriptions/firsttimesubscription`, method: 'PUT',
       headers: {'Content-Type': 'application/json', },
       data: subscriptionFirstTimeSubscriptionBody
@@ -2443,7 +2484,26 @@ export const useSubscriptionChangeSubscriptionPreview = <TError = void,
       return useMutation(mutationOptions);
     }
     /**
- * Returns an invoice object with information about the amount outstanding.
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3) the request is rejected;
+use PUT /billing/stripe/subscriptions/{subscriptionUid}/change instead.
+            
+Returns the new subscription; its StartDate is when the change takes effect. When only add-ons
+change, returns the existing subscription.
+            
+A change of plan, BillingRenewalTerm or quantity ends the current subscription and creates a new
+subscription record. An upgrade starts immediately. Any other change, for example from one free plan
+to another at the same price, is scheduled for the current renewal date, unless the account is in a
+trial or you pass startImmediately=true.
+            
+The dates work as on PUT /api/v1/billing/subscriptions/firsttimesubscription: RenewalDate is
+calculated by Outseta, EndDate is set by Outseta when the subscription ends and can't be sent, and
+ExpirationDate gives the new subscription a fixed end. Without an ExpirationDate, the new subscription
+keeps the current one's expiration date when the plan stays the same; otherwise the plan's
+ExpirationDate or ExpiresAfterMonths applies.
+            
+A request with the same plan, BillingRenewalTerm and quantity only changes add-ons; it does not change
+the subscription's dates. To set or remove the end date of the current subscription, use
+PUT /api/v1/crm/accounts/{accountUid}/extend-renewal.
  * @summary Change a subscription on an account.
  */
 export const subscriptionChangeSubscription = (
@@ -2579,6 +2639,9 @@ export function usePlanGetAllPlans<TData = Awaited<ReturnType<typeof planGetAllP
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3), plans are Stripe products
+and prices: use POST /billing/stripe/products and PUT /billing/stripe/products/{uid}. With
+Stripe Billing the request is rejected.
  * @summary Add a new plan.
  */
 export const planAddPlan = (
@@ -2711,6 +2774,9 @@ export function usePlanGetPlan<TData = Awaited<ReturnType<typeof planGetPlan>>,
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3), plans are Stripe products
+and prices: use POST /billing/stripe/products and PUT /billing/stripe/products/{uid}. With
+Stripe Billing the request is rejected.
  * @summary Update a plan.
  */
 export const planUpdatePlan = (
@@ -2980,6 +3046,9 @@ export function usePlanFamilyGetAllPlanFamilies<TData = Awaited<ReturnType<typeo
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3), use product families:
+POST /billing/stripe/product-families and PUT /billing/stripe/product-families/{productFamilyUid}.
+With Stripe Billing the request is rejected.
  * @summary Add a new plan family.
  */
 export const planFamilyAddPlanFamily = (
@@ -3112,6 +3181,9 @@ export function usePlanFamilyGetPlanFamily<TData = Awaited<ReturnType<typeof pla
 
 
 /**
+ * Applies to Outseta billing (v2) only. With Stripe Billing (v3), use product families:
+POST /billing/stripe/product-families and PUT /billing/stripe/product-families/{productFamilyUid}.
+With Stripe Billing the request is rejected.
  * @summary Update a plan family.
  */
 export const planFamilyUpdatePlanFamily = (