autumn-js 1.2.45 → 1.2.47

package/dist/backend/{routeTypes-UN48tvoc.d.mts → routeTypes-D4za8Mi4.d.mts}

@@ -10012,6 +10012,313 @@ type CreateReferralCodeResponse = {
     createdAt: number;
 };
 
+declare const DurationTypeRequestBody: {
+    readonly OneOff: "one_off";
+    readonly Months: "months";
+    readonly Forever: "forever";
+};
+type DurationTypeRequestBody = ClosedEnum<typeof DurationTypeRequestBody>;
+/**
+ * Use a positive integer length for months, and null for one_off or forever.
+ */
+type CreateRewardDuration = {
+    type: DurationTypeRequestBody;
+    length: number | null;
+};
+type CreateRewardCouponPromoCode = {
+    code: string;
+    globalMaxRedemption?: number | null | undefined;
+    firstTimeTransaction?: boolean | null | undefined;
+};
+declare const CouponTypeRequestBody: {
+    readonly PercentageDiscount: "percentage_discount";
+    readonly FixedDiscount: "fixed_discount";
+};
+type CouponTypeRequestBody = ClosedEnum<typeof CouponTypeRequestBody>;
+/**
+ * Provide exactly one of coupon or feature_grant, not both.
+ */
+type CreateRewardCouponRequest = {
+    id: string;
+    name: string;
+    /**
+     * Use a positive integer length for months, and null for one_off or forever.
+     */
+    duration: CreateRewardDuration;
+    /**
+     * Plan IDs must be unique.
+     */
+    planIds: Array<string> | null;
+    /**
+     * Promo code values must be unique.
+     */
+    promoCodes: Array<CreateRewardCouponPromoCode>;
+    type: CouponTypeRequestBody;
+    /**
+     * Percentage discounts must be at most 100; fixed discounts must be positive.
+     */
+    value: number;
+};
+/**
+ * The unit of time the grant lasts.
+ */
+declare const ExpiryTypeRequestBody: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Year: "year";
+};
+/**
+ * The unit of time the grant lasts.
+ */
+type ExpiryTypeRequestBody = ClosedEnum<typeof ExpiryTypeRequestBody>;
+type ExpiryRequest = {
+    /**
+     * The unit of time the grant lasts.
+     */
+    type: ExpiryTypeRequestBody;
+    /**
+     * The positive integer count of periods before the grant expires.
+     */
+    length: number;
+};
+type CreateRewardGrant = {
+    featureId: string;
+    /**
+     * A positive amount to grant, or null for boolean features.
+     */
+    included: number | null;
+    expiry: ExpiryRequest | null;
+};
+type CreateRewardFeatureGrantPromoCode = {
+    code: string;
+    /**
+     * A positive redemption limit, or null for unlimited uses.
+     */
+    maxUses: number | null;
+};
+/**
+ * Provide exactly one of coupon or feature_grant, not both.
+ */
+type CreateRewardFeatureGrantRequest = {
+    id: string;
+    name: string;
+    /**
+     * Feature IDs must be unique.
+     */
+    grants: Array<CreateRewardGrant>;
+    /**
+     * Promo code values must be unique.
+     */
+    promoCodes: Array<CreateRewardFeatureGrantPromoCode>;
+};
+type CreateRewardParams = {
+    /**
+     * Provide exactly one of coupon or feature_grant, not both.
+     */
+    coupon?: CreateRewardCouponRequest | undefined;
+    /**
+     * Provide exactly one of coupon or feature_grant, not both.
+     */
+    featureGrant?: CreateRewardFeatureGrantRequest | undefined;
+};
+/**
+ * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
+ */
+declare const CreateRewardCouponTypeResponse: {
+    readonly PercentageDiscount: "percentage_discount";
+    readonly FixedDiscount: "fixed_discount";
+    readonly InvoiceCredits: "invoice_credits";
+};
+/**
+ * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
+ */
+type CreateRewardCouponTypeResponse = OpenEnum<typeof CreateRewardCouponTypeResponse>;
+/**
+ * The unit of time the duration is measured in.
+ */
+declare const CreateRewardDurationTypeResponse: {
+    readonly OneOff: "one_off";
+    readonly Months: "months";
+    readonly Forever: "forever";
+};
+/**
+ * The unit of time the duration is measured in.
+ */
+type CreateRewardDurationTypeResponse = OpenEnum<typeof CreateRewardDurationTypeResponse>;
+/**
+ * How long the coupon applies once redeemed.
+ */
+type CreateRewardDurationResponse = {
+    /**
+     * The unit of time the duration is measured in.
+     */
+    type: CreateRewardDurationTypeResponse;
+    /**
+     * The number of `type` periods the duration lasts, or null when the type has no length (e.g. one_off, forever).
+     */
+    length: number | null;
+};
+type CreateRewardCouponPromoCodeResponse = {
+    /**
+     * The promo code customers enter to redeem the coupon.
+     */
+    code: string;
+    /**
+     * Maximum number of times this promo code can be redeemed across all customers, or null for unlimited.
+     */
+    globalMaxRedemption?: number | null | undefined;
+    /**
+     * Whether this promo code can only be applied to a customer's first transaction.
+     */
+    firstTimeTransaction?: boolean | null | undefined;
+};
+type CreateRewardCouponResponse = {
+    /**
+     * The unique identifier for the coupon.
+     */
+    id: string;
+    /**
+     * A human-readable name for the coupon.
+     */
+    name?: string | null | undefined;
+    /**
+     * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
+     */
+    type: CreateRewardCouponTypeResponse;
+    /**
+     * The discount value. A percentage for percentage_discount, or an amount for fixed_discount / invoice_credits.
+     */
+    value: number;
+    /**
+     * How long the coupon applies once redeemed.
+     */
+    duration: CreateRewardDurationResponse;
+    /**
+     * The plan IDs the coupon applies to, or null when it applies to all plans.
+     */
+    planIds: Array<string> | null;
+    promoCodes: Array<CreateRewardCouponPromoCodeResponse>;
+    /**
+     * The Unix timestamp (in milliseconds) when the coupon was created.
+     */
+    createdAt: number;
+};
+/**
+ * The unit of time the grant lasts.
+ */
+declare const CreateRewardExpiryTypeResponse: {
+    readonly Day: "day";
+    readonly Week: "week";
+    readonly Month: "month";
+    readonly Year: "year";
+};
+/**
+ * The unit of time the grant lasts.
+ */
+type CreateRewardExpiryTypeResponse = OpenEnum<typeof CreateRewardExpiryTypeResponse>;
+type CreateRewardExpiryResponse = {
+    /**
+     * The unit of time the grant lasts.
+     */
+    type: CreateRewardExpiryTypeResponse;
+    /**
+     * The positive integer count of periods before the grant expires.
+     */
+    length: number;
+};
+type CreateRewardGrantResponse = {
+    /**
+     * The feature ID this grant applies to.
+     */
+    featureId: string;
+    /**
+     * The amount of the feature granted, or null for boolean features.
+     */
+    included: number | null;
+    /**
+     * How long the granted amount lasts before expiring, or null for a permanent grant.
+     */
+    expiry: CreateRewardExpiryResponse | null;
+};
+type CreateRewardFeatureGrantPromoCodeResponse = {
+    /**
+     * The promo code customers enter to redeem the feature grant.
+     */
+    code: string;
+    /**
+     * Maximum number of times this promo code can be redeemed, or null for unlimited.
+     */
+    maxUses: number | null;
+};
+type CreateRewardFeatureGrantResponse = {
+    /**
+     * The unique identifier for the feature grant.
+     */
+    id: string;
+    /**
+     * A human-readable name for the feature grant.
+     */
+    name?: string | null | undefined;
+    grants: Array<CreateRewardGrantResponse>;
+    promoCodes: Array<CreateRewardFeatureGrantPromoCodeResponse>;
+    /**
+     * The Unix timestamp (in milliseconds) when the feature grant was created.
+     */
+    createdAt: number;
+};
+/**
+ * OK
+ */
+type CreateRewardResponse = {
+    coupon?: CreateRewardCouponResponse | undefined;
+    featureGrant?: CreateRewardFeatureGrantResponse | undefined;
+};
+
+/**
+ * Unit of time for the trial ('day', 'month', 'year').
+ */
+declare const CreateScheduleFreeTrialDurationType: {
+    readonly Day: "day";
+    readonly Month: "month";
+    readonly Year: "year";
+};
+/**
+ * Unit of time for the trial ('day', 'month', 'year').
+ */
+type CreateScheduleFreeTrialDurationType = ClosedEnum<typeof CreateScheduleFreeTrialDurationType>;
+/**
+ * Behavior when the trial ends. 'bill' charges the customer (default). 'revert' expires the trial and restores the customer's previous plan.
+ */
+declare const CreateScheduleOnEnd: {
+    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 CreateScheduleOnEnd = ClosedEnum<typeof CreateScheduleOnEnd>;
+/**
+ * Free trial configuration for a plan.
+ */
+type CreateScheduleFreeTrialParams = {
+    /**
+     * Number of duration_type periods the trial lasts.
+     */
+    durationLength: number;
+    /**
+     * Unit of time for the trial ('day', 'month', 'year').
+     */
+    durationType?: CreateScheduleFreeTrialDurationType | undefined;
+    /**
+     * 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?: CreateScheduleOnEnd | undefined;
+};
 /**
  * Invoice mode creates and sends an invoice instead of charging the customer's payment method immediately for the first phase.
  */
@@ -10076,14 +10383,14 @@ type CreateScheduleBillingBehavior = ClosedEnum<typeof CreateScheduleBillingBeha
 /**
  * The duration unit to offset this phase from the prior phase.
  */
-declare const CreateScheduleDurationType2: {
+declare const PhaseStartDurationType: {
     readonly Month: "month";
     readonly Year: "year";
 };
 /**
  * The duration unit to offset this phase from the prior phase.
  */
-type CreateScheduleDurationType2 = ClosedEnum<typeof CreateScheduleDurationType2>;
+type PhaseStartDurationType = ClosedEnum<typeof PhaseStartDurationType>;
 /**
  * Relative start offset from the previous resolved schedule phase.
  */
@@ -10091,7 +10398,7 @@ type StartingAfter2 = {
     /**
      * The duration unit to offset this phase from the prior phase.
      */
-    durationType: CreateScheduleDurationType2;
+    durationType: PhaseStartDurationType;
     /**
      * How many duration_type periods after the prior phase to start.
      */
@@ -10887,6 +11194,10 @@ type CreateSchedulePlan2 = {
      * The ID of the plan to schedule in this phase.
      */
     planId: string;
+    /**
+     * The immediate plan scope. Omit to inherit the request entity, pass null for customer-level, or pass an entity ID.
+     */
+    entityId?: string | null | undefined;
     /**
      * Optional prepaid feature quantities for this phase's plan.
      */
@@ -10941,6 +11252,14 @@ type CreateScheduleParams = {
      * Optional entity ID for an entity-scoped schedule.
      */
     entityId?: string | undefined;
+    /**
+     * Free trial configuration applied to every plan in the immediate phase.
+     */
+    freeTrial?: CreateScheduleFreeTrialParams | null | undefined;
+    /**
+     * Three-letter Stripe-supported currency code used to bill the immediate phase (for example, 'usd').
+     */
+    currency?: string | undefined;
     /**
      * Invoice mode creates and sends an invoice instead of charging the customer's payment method immediately for the first phase.
      */
@@ -10975,6 +11294,10 @@ type CreateScheduleParams = {
      * If true, the immediate-phase cusProducts are activated immediately (and scheduled-phase cusProducts pre-inserted) even when payment is pending via Stripe checkout. The Autumn schedule rows are persisted on checkout.session.completed.
      */
     enablePlanImmediately?: boolean | undefined;
+    /**
+     * If true, active recurring add-ons in scopes represented by the phase plans are retained.
+     */
+    preserveAddOns?: boolean | undefined;
     /**
      * Ordered phase definitions for the schedule.
      */
@@ -18740,7 +19063,7 @@ type RewardsListParams = {};
 /**
  * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
  */
-declare const CouponType: {
+declare const ListRewardsCouponType: {
     readonly PercentageDiscount: "percentage_discount";
     readonly FixedDiscount: "fixed_discount";
     readonly InvoiceCredits: "invoice_credits";
@@ -18748,11 +19071,11 @@ declare const CouponType: {
 /**
  * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
  */
-type CouponType = OpenEnum<typeof CouponType>;
+type ListRewardsCouponType = OpenEnum<typeof ListRewardsCouponType>;
 /**
  * The unit of time the duration is measured in.
  */
-declare const DurationType: {
+declare const ListRewardsDurationType: {
     readonly OneOff: "one_off";
     readonly Months: "months";
     readonly Forever: "forever";
@@ -18760,7 +19083,7 @@ declare const DurationType: {
 /**
  * The unit of time the duration is measured in.
  */
-type DurationType = OpenEnum<typeof DurationType>;
+type ListRewardsDurationType = OpenEnum<typeof ListRewardsDurationType>;
 /**
  * How long the coupon applies once redeemed.
  */
@@ -18768,13 +19091,13 @@ type ListRewardsDuration = {
     /**
      * The unit of time the duration is measured in.
      */
-    type: DurationType;
+    type: ListRewardsDurationType;
     /**
      * The number of `type` periods the duration lasts, or null when the type has no length (e.g. one_off, forever).
      */
     length: number | null;
 };
-type CouponPromoCode = {
+type ListRewardsCouponPromoCode = {
     /**
      * The promo code customers enter to redeem the coupon.
      */
@@ -18800,7 +19123,7 @@ type Coupon = {
     /**
      * The type of discount: percentage_discount, fixed_discount, or invoice_credits.
      */
-    type: CouponType;
+    type: ListRewardsCouponType;
     /**
      * The discount value. A percentage for percentage_discount, or an amount for fixed_discount / invoice_credits.
      */
@@ -18816,36 +19139,36 @@ type Coupon = {
     /**
      * The promo codes customers can use to redeem the coupon.
      */
-    promoCodes: Array<CouponPromoCode>;
+    promoCodes: Array<ListRewardsCouponPromoCode>;
     /**
      * The Unix timestamp (in milliseconds) when the coupon was created.
      */
     createdAt: number;
 };
 /**
- * The unit of time the duration is measured in.
+ * The unit of time the grant lasts.
  */
-declare const ExpiryType: {
+declare const ListRewardsExpiryType: {
     readonly Day: "day";
     readonly Week: "week";
     readonly Month: "month";
     readonly Year: "year";
 };
 /**
- * The unit of time the duration is measured in.
+ * The unit of time the grant lasts.
  */
-type ExpiryType = OpenEnum<typeof ExpiryType>;
-type Expiry = {
+type ListRewardsExpiryType = OpenEnum<typeof ListRewardsExpiryType>;
+type ListRewardsExpiry = {
     /**
-     * The unit of time the duration is measured in.
+     * The unit of time the grant lasts.
      */
-    type: ExpiryType;
+    type: ListRewardsExpiryType;
     /**
-     * The number of `type` periods the duration lasts, or null when the type has no length (e.g. one_off, forever).
+     * The positive integer count of periods before the grant expires.
      */
-    length: number | null;
+    length: number;
 };
-type Grant = {
+type ListRewardsGrant = {
     /**
      * The feature ID this grant applies to.
      */
@@ -18857,9 +19180,9 @@ type Grant = {
     /**
      * How long the granted amount lasts before expiring, or null for a permanent grant.
      */
-    expiry: Expiry | null;
+    expiry: ListRewardsExpiry | null;
 };
-type FeatureGrantPromoCode = {
+type ListRewardsFeatureGrantPromoCode = {
     /**
      * The promo code customers enter to redeem the feature grant.
      */
@@ -18881,11 +19204,11 @@ type FeatureGrant = {
     /**
      * The feature grants awarded when the grant is redeemed.
      */
-    grants: Array<Grant>;
+    grants: Array<ListRewardsGrant>;
     /**
      * The promo codes customers can use to redeem the feature grant.
      */
-    promoCodes: Array<FeatureGrantPromoCode>;
+    promoCodes: Array<ListRewardsFeatureGrantPromoCode>;
     /**
      * The Unix timestamp (in milliseconds) when the feature grant was created.
      */
@@ -19217,7 +19540,7 @@ type MultiAttachPlanItem = {
     rollover?: MultiAttachRollover | undefined;
 };
 /**
- * Customize the plan to attach. Can override the price, items, or licenses.
+ * Customize the plan to attach. Can override its price or items.
  */
 type MultiAttachCustomize = {
     /**
@@ -19252,7 +19575,7 @@ type MultiAttachPlan = {
      */
     planId: string;
     /**
-     * Customize the plan to attach. Can override the price, items, or licenses.
+     * Customize the plan to attach. Can override its price or items.
      */
     customize?: MultiAttachCustomize | undefined;
     /**
@@ -19267,6 +19590,10 @@ type MultiAttachPlan = {
      * A unique ID to identify this subscription. Useful when attaching the same plan multiple times.
      */
     subscriptionId?: string | undefined;
+    /**
+     * The entity scope for this plan. Omit to inherit the request scope, or pass null for customer-level.
+     */
+    entityId?: string | null | undefined;
 };
 /**
  * Unit of time for the trial ('day', 'month', 'year').
@@ -19350,6 +19677,17 @@ type MultiAttachAttachDiscount = {
      */
     promotionCode?: string | undefined;
 };
+/**
+ * How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything.
+ */
+declare const MultiAttachBillingBehavior: {
+    readonly ProrateImmediately: "prorate_immediately";
+    readonly None: "none";
+};
+/**
+ * How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything.
+ */
+type MultiAttachBillingBehavior = ClosedEnum<typeof MultiAttachBillingBehavior>;
 /**
  * Controls when to return a checkout URL. 'always' returns a URL even if payment succeeds, 'if_required' only when payment action is needed, 'never' disables redirects.
  */
@@ -19535,6 +19873,10 @@ type MultiAttachParams = {
      * Free trial configuration applied to all plans. Pass an object to set a custom trial, or null to remove any trial.
      */
     freeTrial?: MultiAttachFreeTrialParams | null | undefined;
+    /**
+     * Unix timestamp in milliseconds for backdating every plan in this multi-attach.
+     */
+    startsAt?: number | undefined;
     /**
      * Currency to bill this multi-attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one, and every plan must offer a paid price in it. Defaults to the customer's currency, then the org default.
      */
@@ -19547,6 +19889,10 @@ type MultiAttachParams = {
      * List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.
      */
     discounts?: Array<MultiAttachAttachDiscount> | undefined;
+    /**
+     * How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything.
+     */
+    billingBehavior?: MultiAttachBillingBehavior | undefined;
     /**
      * URL to redirect to after successful checkout.
      */
@@ -21905,7 +22251,7 @@ type PreviewMultiAttachPlanItem = {
     rollover?: PreviewMultiAttachRollover | undefined;
 };
 /**
- * Customize the plan to attach. Can override the price, items, or licenses.
+ * Customize the plan to attach. Can override its price or items.
  */
 type PreviewMultiAttachCustomize = {
     /**
@@ -21940,7 +22286,7 @@ type PreviewMultiAttachPlan = {
      */
     planId: string;
     /**
-     * Customize the plan to attach. Can override the price, items, or licenses.
+     * Customize the plan to attach. Can override its price or items.
      */
     customize?: PreviewMultiAttachCustomize | undefined;
     /**
@@ -21955,6 +22301,10 @@ type PreviewMultiAttachPlan = {
      * A unique ID to identify this subscription. Useful when attaching the same plan multiple times.
      */
     subscriptionId?: string | undefined;
+    /**
+     * The entity scope for this plan. Omit to inherit the request scope, or pass null for customer-level.
+     */
+    entityId?: string | null | undefined;
 };
 /**
  * Unit of time for the trial ('day', 'month', 'year').
@@ -22038,6 +22388,17 @@ type PreviewMultiAttachAttachDiscount = {
      */
     promotionCode?: string | undefined;
 };
+/**
+ * How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything.
+ */
+declare const PreviewMultiAttachBillingBehavior: {
+    readonly ProrateImmediately: "prorate_immediately";
+    readonly None: "none";
+};
+/**
+ * How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything.
+ */
+type PreviewMultiAttachBillingBehavior = ClosedEnum<typeof PreviewMultiAttachBillingBehavior>;
 /**
  * Controls when to return a checkout URL. 'always' returns a URL even if payment succeeds, 'if_required' only when payment action is needed, 'never' disables redirects.
  */
@@ -22223,6 +22584,10 @@ type PreviewMultiAttachParams = {
      * Free trial configuration applied to all plans. Pass an object to set a custom trial, or null to remove any trial.
      */
     freeTrial?: PreviewMultiAttachFreeTrialParams | null | undefined;
+    /**
+     * Unix timestamp in milliseconds for backdating every plan in this multi-attach.
+     */
+    startsAt?: number | undefined;
     /**
      * Currency to bill this multi-attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one, and every plan must offer a paid price in it. Defaults to the customer's currency, then the org default.
      */
@@ -22235,6 +22600,10 @@ type PreviewMultiAttachParams = {
      * List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code.
      */
     discounts?: Array<PreviewMultiAttachAttachDiscount> | undefined;
+    /**
+     * How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything.
+     */
+    billingBehavior?: PreviewMultiAttachBillingBehavior | undefined;
     /**
      * URL to redirect to after successful checkout.
      */
@@ -31969,11 +32338,13 @@ 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":1785242875734,"plans":[{"planId":"trial_plan"}]},{"startsAt":1786452475734,"plans":[{"planId":"pro_plan"}]}] });
+     * const response = await client.billing.createSchedule({ customerId: "cus_123", phases: [{"startsAt":"now","plans":[{"planId":"trial_plan"}]},{"startingAfter":{"durationType":"month","durationCount":1},"plans":[{"planId":"pro_plan"}]}] });
      * ```
      *
      * @param customerId - The ID of the customer to create the schedule for.
      * @param entityId - Optional entity ID for an entity-scoped schedule. (optional)
+     * @param freeTrial - Free trial configuration applied to every plan in the immediate phase. (optional)
+     * @param currency - Three-letter Stripe-supported currency code used to bill the immediate phase (for example, 'usd'). (optional)
      * @param invoiceMode - Invoice mode creates and sends an invoice instead of charging the customer's payment method immediately for the first phase. (optional)
      * @param discounts - List of discounts to apply to the immediate phase. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code. (optional)
      * @param successUrl - URL to redirect to after successful checkout. (optional)
@@ -31982,6 +32353,7 @@ declare class Billing extends ClientSDK {
      * @param billingBehavior - Whether to prorate the immediate phase. 'none' skips proration charges and credits. (optional)
      * @param billingCycleAnchor - Pass 'now' to reset the billing cycle anchor of the immediate phase to the current time. (optional)
      * @param enablePlanImmediately - If true, the immediate-phase cusProducts are activated immediately (and scheduled-phase cusProducts pre-inserted) even when payment is pending via Stripe checkout. The Autumn schedule rows are persisted on checkout.session.completed. (optional)
+     * @param preserveAddOns - If true, active recurring add-ons in scopes represented by the phase plans are retained. (optional)
      * @param phases - Ordered phase definitions for the schedule.
      *
      * @returns A create-schedule response with the schedule ID, persisted phases, and any required payment or checkout URL.
@@ -32014,9 +32386,11 @@ declare class Billing extends ClientSDK {
      * @param entityId - The ID of the entity to attach the plans to. (optional)
      * @param plans - The list of plans to attach to the customer.
      * @param freeTrial - Free trial configuration applied to all plans. Pass an object to set a custom trial, or null to remove any trial. (optional)
+     * @param startsAt - Unix timestamp in milliseconds for backdating every plan in this multi-attach. (optional)
      * @param currency - Currency to bill this multi-attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one, and every plan must offer a paid price in it. Defaults to the customer's currency, then the org default. (optional)
      * @param invoiceMode - Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately. (optional)
      * @param discounts - List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code. (optional)
+     * @param billingBehavior - How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything. (optional)
      * @param successUrl - URL to redirect to after successful checkout. (optional)
      * @param checkoutSessionParams - Additional parameters to pass into the creation of the Stripe checkout session. (optional)
      * @param redirectMode - Controls when to return a checkout URL. 'always' returns a URL even if payment succeeds, 'if_required' only when payment action is needed, 'never' disables redirects. (optional)
@@ -32085,9 +32459,11 @@ declare class Billing extends ClientSDK {
      * @param entityId - The ID of the entity to attach the plans to. (optional)
      * @param plans - The list of plans to attach to the customer.
      * @param freeTrial - Free trial configuration applied to all plans. Pass an object to set a custom trial, or null to remove any trial. (optional)
+     * @param startsAt - Unix timestamp in milliseconds for backdating every plan in this multi-attach. (optional)
      * @param currency - Currency to bill this multi-attach in (e.g. usd, eur). Must match the customer's currency if they are already locked to one, and every plan must offer a paid price in it. Defaults to the customer's currency, then the org default. (optional)
      * @param invoiceMode - Invoice mode creates a draft or open invoice and sends it to the customer, instead of charging their card immediately. (optional)
      * @param discounts - List of discounts to apply. Each discount can be an Autumn reward ID, Stripe coupon ID, or Stripe promotion code. (optional)
+     * @param billingBehavior - How to handle billing. 'prorate_immediately' charges/credits prorated amounts now, 'none' does not charge/credit anything. (optional)
      * @param successUrl - URL to redirect to after successful checkout. (optional)
      * @param checkoutSessionParams - Additional parameters to pass into the creation of the Stripe checkout session. (optional)
      * @param redirectMode - Controls when to return a checkout URL. 'always' returns a URL even if payment succeeds, 'if_required' only when payment action is needed, 'never' disables redirects. (optional)
@@ -32809,6 +33185,10 @@ declare class Referrals extends ClientSDK {
 }
 
 declare class Rewards extends ClientSDK {
+    /**
+     * Create a coupon or feature grant.
+     */
+    create(request: CreateRewardParams, options?: RequestOptions): Promise<CreateRewardResponse>;
     /**
      * List the coupons and feature grants configured for the org.
      */