autumn-js 1.2.21 → 1.2.23

package/dist/backend/index.mjs

@@ -1,27 +1,27 @@
 import "./chunk-WYDGEDEU.mjs";
 import "./chunk-VXND2UDT.mjs";
-import "./chunk-73KXFYFC.mjs";
+import "./chunk-RKIVVLR3.mjs";
 import {
   createCoreHandler
-} from "./chunk-H6KJYTJY.mjs";
+} from "./chunk-W5UYBM7S.mjs";
+import "./chunk-T4ZAR3BE.mjs";
+import "./chunk-55C2WWXQ.mjs";
+import "./chunk-TBQ27LIK.mjs";
+import "./chunk-J44WR3QZ.mjs";
 import "./chunk-TSF4YCUO.mjs";
 import {
   buildRouter
 } from "./chunk-UAR3TMWI.mjs";
-import "./chunk-GKYVE5XN.mjs";
 import {
   routeConfigs
-} from "./chunk-NSHGFU5H.mjs";
-import "./chunk-S5HPMJ4U.mjs";
+} from "./chunk-VHEQZSCT.mjs";
 import "./chunk-OTXV5FY7.mjs";
-import {
-  sanitizeBody
-} from "./chunk-Z6QP3YEA.mjs";
 import {
   secretKeyCheck
 } from "./chunk-VZIMT7AO.mjs";
-import "./chunk-TBQ27LIK.mjs";
-import "./chunk-J44WR3QZ.mjs";
+import {
+  sanitizeBody
+} from "./chunk-Z6QP3YEA.mjs";
 import {
   backendError,
   backendSuccess,

package/dist/backend/{routeTypes-DZFxBYSb.d.mts → routeTypes-BBNqffnK.d.mts}

@@ -172,7 +172,7 @@ type EventsAggregateParams = {
      */
     featureId: string | Array<string>;
     /**
-     * Property to group events by (e.g. "properties.region"), or "$customer_id" / "$entity_id" to group by those columns
+     * Property to group events by (e.g. "properties.region"), or "$customer_id" / "$entity_id" / "$plan_id" to group by those columns
      */
     groupBy?: string | undefined;
     /**
@@ -760,6 +760,17 @@ declare const AttachDurationType: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type AttachDurationType = ClosedEnum<typeof AttachDurationType>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const AttachOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type AttachOnEnd = ClosedEnum<typeof AttachOnEnd>;
 /**
  * Free trial configuration for a plan.
  */
@@ -776,6 +787,10 @@ type AttachFreeTrialParams = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: AttachOnEnd | undefined;
 };
 /**
  * Customize the plan to attach. Can override the price, items, free trial, or a combination.
@@ -1845,6 +1860,17 @@ declare const BillingUpdateDurationType: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type BillingUpdateDurationType = ClosedEnum<typeof BillingUpdateDurationType>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const BillingUpdateOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type BillingUpdateOnEnd = ClosedEnum<typeof BillingUpdateOnEnd>;
 /**
  * Free trial configuration for a plan.
  */
@@ -1861,6 +1887,10 @@ type BillingUpdateFreeTrialParams = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: BillingUpdateOnEnd | undefined;
 };
 /**
  * Customize the plan to attach. Can override the price, items, free trial, or a combination.
@@ -2422,6 +2452,11 @@ declare const FreeTrialDuration2: {
  * The duration type of the free trial
  */
 type FreeTrialDuration2 = OpenEnum<typeof FreeTrialDuration2>;
+declare const CheckOnEnd2: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+type CheckOnEnd2 = OpenEnum<typeof CheckOnEnd2>;
 type CheckFreeTrial2 = {
     /**
      * The duration type of the free trial
@@ -2439,6 +2474,10 @@ type CheckFreeTrial2 = {
      * Whether the free trial requires a card. If false, the customer can attach the product without going through a checkout flow or having a card on file.
      */
     cardRequired: boolean;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: CheckOnEnd2 | null | undefined;
     /**
      * Used in customer context. Whether the free trial is available for the customer if they were to attach the product.
      */
@@ -2878,6 +2917,11 @@ declare const FreeTrialDuration1: {
  * The duration type of the free trial
  */
 type FreeTrialDuration1 = OpenEnum<typeof FreeTrialDuration1>;
+declare const CheckOnEnd1: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+type CheckOnEnd1 = OpenEnum<typeof CheckOnEnd1>;
 type CheckFreeTrial1 = {
     /**
      * The duration type of the free trial
@@ -2895,6 +2939,10 @@ type CheckFreeTrial1 = {
      * Whether the free trial requires a card. If false, the customer can attach the product without going through a checkout flow or having a card on file.
      */
     cardRequired: boolean;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: CheckOnEnd1 | null | undefined;
     /**
      * Used in customer context. Whether the free trial is available for the customer if they were to attach the product.
      */
@@ -3639,6 +3687,11 @@ declare const PlanDurationType: {
  * Unit of time for the trial duration ('day', 'month', 'year').
  */
 type PlanDurationType = OpenEnum<typeof PlanDurationType>;
+declare const OnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+type OnEnd = OpenEnum<typeof OnEnd>;
 /**
  * Free trial configuration. If set, new customers can try this plan before being charged.
  */
@@ -3655,6 +3708,10 @@ type FreeTrial = {
      * Whether a payment method is required to start the trial. If true, customer will be charged after trial ends.
      */
     cardRequired: boolean;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: OnEnd | null | undefined;
 };
 /**
  * Environment this plan belongs to ('sandbox' or 'live').
@@ -4619,6 +4676,17 @@ declare const CreatePlanDurationTypeRequest: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type CreatePlanDurationTypeRequest = ClosedEnum<typeof CreatePlanDurationTypeRequest>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const CreatePlanOnEndRequest: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type CreatePlanOnEndRequest = ClosedEnum<typeof CreatePlanOnEndRequest>;
 /**
  * Free trial configuration. Customers can try this plan before being charged.
  */
@@ -4635,6 +4703,10 @@ type FreeTrialRequest = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: CreatePlanOnEndRequest | undefined;
 };
 /**
  * Miscellaneous plan-level configuration flags.
@@ -4978,6 +5050,11 @@ declare const CreatePlanDurationTypeResponse: {
  * Unit of time for the trial duration ('day', 'month', 'year').
  */
 type CreatePlanDurationTypeResponse = OpenEnum<typeof CreatePlanDurationTypeResponse>;
+declare const CreatePlanOnEndResponse: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+type CreatePlanOnEndResponse = OpenEnum<typeof CreatePlanOnEndResponse>;
 /**
  * Free trial configuration. If set, new customers can try this plan before being charged.
  */
@@ -4994,6 +5071,10 @@ type CreatePlanFreeTrialResponse = {
      * Whether a payment method is required to start the trial. If true, customer will be charged after trial ends.
      */
     cardRequired: boolean;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: CreatePlanOnEndResponse | null | undefined;
 };
 /**
  * Environment this plan belongs to ('sandbox' or 'live').
@@ -7931,6 +8012,11 @@ declare const GetPlanDurationType: {
  * Unit of time for the trial duration ('day', 'month', 'year').
  */
 type GetPlanDurationType = OpenEnum<typeof GetPlanDurationType>;
+declare const GetPlanOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+type GetPlanOnEnd = OpenEnum<typeof GetPlanOnEnd>;
 /**
  * Free trial configuration. If set, new customers can try this plan before being charged.
  */
@@ -7947,6 +8033,10 @@ type GetPlanFreeTrial = {
      * Whether a payment method is required to start the trial. If true, customer will be charged after trial ends.
      */
     cardRequired: boolean;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: GetPlanOnEnd | null | undefined;
 };
 /**
  * Environment this plan belongs to ('sandbox' or 'live').
@@ -9648,6 +9738,11 @@ declare const ListPlansDurationType: {
  * Unit of time for the trial duration ('day', 'month', 'year').
  */
 type ListPlansDurationType = OpenEnum<typeof ListPlansDurationType>;
+declare const ListPlansOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+type ListPlansOnEnd = OpenEnum<typeof ListPlansOnEnd>;
 /**
  * Free trial configuration. If set, new customers can try this plan before being charged.
  */
@@ -9664,6 +9759,10 @@ type ListPlansFreeTrial = {
      * Whether a payment method is required to start the trial. If true, customer will be charged after trial ends.
      */
     cardRequired: boolean;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: ListPlansOnEnd | null | undefined;
 };
 /**
  * Environment this plan belongs to ('sandbox' or 'live').
@@ -10107,6 +10206,17 @@ declare const MultiAttachDurationType: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type MultiAttachDurationType = ClosedEnum<typeof MultiAttachDurationType>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const MultiAttachOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type MultiAttachOnEnd = ClosedEnum<typeof MultiAttachOnEnd>;
 /**
  * Free trial configuration for a plan.
  */
@@ -10123,6 +10233,10 @@ type MultiAttachFreeTrialParams = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: MultiAttachOnEnd | undefined;
 };
 /**
  * Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately.
@@ -10929,6 +11043,17 @@ declare const PreviewAttachDurationType: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type PreviewAttachDurationType = ClosedEnum<typeof PreviewAttachDurationType>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const PreviewAttachOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type PreviewAttachOnEnd = ClosedEnum<typeof PreviewAttachOnEnd>;
 /**
  * Free trial configuration for a plan.
  */
@@ -10945,6 +11070,10 @@ type PreviewAttachFreeTrialParams = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: PreviewAttachOnEnd | undefined;
 };
 /**
  * Customize the plan to attach. Can override the price, items, free trial, or a combination.
@@ -11824,6 +11953,17 @@ declare const PreviewMultiAttachDurationType: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type PreviewMultiAttachDurationType = ClosedEnum<typeof PreviewMultiAttachDurationType>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const PreviewMultiAttachOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type PreviewMultiAttachOnEnd = ClosedEnum<typeof PreviewMultiAttachOnEnd>;
 /**
  * Free trial configuration for a plan.
  */
@@ -11840,6 +11980,10 @@ type PreviewMultiAttachFreeTrialParams = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: PreviewMultiAttachOnEnd | undefined;
 };
 /**
  * Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately.
@@ -12887,6 +13031,17 @@ declare const PreviewUpdateDurationType: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type PreviewUpdateDurationType = ClosedEnum<typeof PreviewUpdateDurationType>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const PreviewUpdateOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type PreviewUpdateOnEnd = ClosedEnum<typeof PreviewUpdateOnEnd>;
 /**
  * Free trial configuration for a plan.
  */
@@ -12903,6 +13058,10 @@ type PreviewUpdateFreeTrialParams = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: PreviewUpdateOnEnd | undefined;
 };
 /**
  * Customize the plan to attach. Can override the price, items, free trial, or a combination.
@@ -13954,6 +14113,17 @@ declare const SetupPaymentDurationType: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type SetupPaymentDurationType = ClosedEnum<typeof SetupPaymentDurationType>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const SetupPaymentOnEnd: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type SetupPaymentOnEnd = ClosedEnum<typeof SetupPaymentOnEnd>;
 /**
  * Free trial configuration for a plan.
  */
@@ -13970,6 +14140,10 @@ type SetupPaymentFreeTrialParams = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: SetupPaymentOnEnd | undefined;
 };
 /**
  * Customize the plan to attach. Can override the price, items, free trial, or a combination.
@@ -15944,6 +16118,17 @@ declare const UpdatePlanDurationTypeRequest: {
  * Unit of time for the trial ('day', 'month', 'year').
  */
 type UpdatePlanDurationTypeRequest = ClosedEnum<typeof UpdatePlanDurationTypeRequest>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const UpdatePlanOnEndRequest: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+type UpdatePlanOnEndRequest = ClosedEnum<typeof UpdatePlanOnEndRequest>;
 /**
  * Free trial configuration for a plan.
  */
@@ -15960,6 +16145,10 @@ type UpdatePlanFreeTrialParams = {
      * If true, payment method required to start trial. Customer is charged after trial ends.
      */
     cardRequired?: boolean | undefined;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: UpdatePlanOnEndRequest | undefined;
 };
 /**
  * Miscellaneous plan-level configuration flags.
@@ -16306,6 +16495,11 @@ declare const UpdatePlanDurationTypeResponse: {
  * Unit of time for the trial duration ('day', 'month', 'year').
  */
 type UpdatePlanDurationTypeResponse = OpenEnum<typeof UpdatePlanDurationTypeResponse>;
+declare const UpdatePlanOnEndResponse: {
+    readonly Bill: "bill";
+    readonly Revert: "revert";
+};
+type UpdatePlanOnEndResponse = OpenEnum<typeof UpdatePlanOnEndResponse>;
 /**
  * Free trial configuration. If set, new customers can try this plan before being charged.
  */
@@ -16322,6 +16516,10 @@ type UpdatePlanFreeTrial = {
      * Whether a payment method is required to start the trial. If true, customer will be charged after trial ends.
      */
     cardRequired: boolean;
+    /**
+     * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+     */
+    onEnd?: UpdatePlanOnEndResponse | null | undefined;
 };
 /**
  * Environment this plan belongs to ('sandbox' or 'live').
@@ -16707,7 +16905,7 @@ declare class Billing extends ClientSDK {
      * @example
      * ```typescript
      * // Schedule a transition from a trial plan to a paid plan
-     * const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":1778684108513,"plans":[{"planId":"trial_plan"}]},{"startsAt":1779893708513,"plans":[{"planId":"pro_plan"}]}] });
+     * const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":1778871536585,"plans":[{"planId":"trial_plan"}]},{"startsAt":1780081136585,"plans":[{"planId":"pro_plan"}]}] });
      * ```
      *
      * @param customerId - The ID of the customer to create the schedule for.