@schematichq/schematic-components 2.38.0 → 2.39.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2273,6 +2273,12 @@ declare interface BillingProductForSubscriptionResponseData {
2273
2273
  * @memberof BillingProductForSubscriptionResponseData
2274
2274
  */
2275
2275
  subscriptionItemExternalId?: string | null;
2276
+ /**
2277
+ *
2278
+ * @type {BillingTiersMode}
2279
+ * @memberof BillingProductForSubscriptionResponseData
2280
+ */
2281
+ tiersMode?: BillingTiersMode | null;
2276
2282
  /**
2277
2283
  *
2278
2284
  * @type {Date}
@@ -5517,6 +5523,12 @@ declare interface CompanySubscriptionResponseData {
5517
5523
  * @memberof CompanySubscriptionResponseData
5518
5524
  */
5519
5525
  interval: string;
5526
+ /**
5527
+ * With interval, the subscription's billing period: 3 with month is quarterly. Read from the subscription's line items, since interval alone is month for monthly and quarterly alike.
5528
+ * @type {number}
5529
+ * @memberof CompanySubscriptionResponseData
5530
+ */
5531
+ intervalCount?: number | null;
5520
5532
  /**
5521
5533
  *
5522
5534
  * @type {boolean}
@@ -7494,7 +7506,7 @@ declare interface CustomPlanBillingResponseData {
7494
7506
  */
7495
7507
  daysUntilDue: number;
7496
7508
  /**
7497
- * When a custom plan that doesn't renew ends: the renewal the subscription stops on and the company moves to the default plan. Null for a plan that renews.
7509
+ * When a custom plan that doesn't renew ends: the renewal the subscription stops on and the company moves to the fallback plan. Null for a plan that renews.
7498
7510
  * @type {Date}
7499
7511
  * @memberof CustomPlanBillingResponseData
7500
7512
  */
@@ -8386,6 +8398,19 @@ declare const en: {
8386
8398
  mo: string;
8387
8399
  qtr: string;
8388
8400
  yr: string;
8401
+ wk: string;
8402
+ "X days short": string;
8403
+ "X weeks short": string;
8404
+ "X months short": string;
8405
+ "X years short": string;
8406
+ "X days_one": string;
8407
+ "X days_other": string;
8408
+ "X weeks_one": string;
8409
+ "X weeks_other": string;
8410
+ "X months_one": string;
8411
+ "X months_other": string;
8412
+ "X years_one": string;
8413
+ "X years_other": string;
8389
8414
  "one time": string;
8390
8415
  "billing period": string;
8391
8416
  "billing period_one": string;
@@ -8395,6 +8420,7 @@ declare const en: {
8395
8420
  monthly: string;
8396
8421
  quarterly: string;
8397
8422
  yearly: string;
8423
+ "every period": string;
8398
8424
  "expires after purchase": string;
8399
8425
  "expires at the end of the billing period": string;
8400
8426
  "expires at the end of the next billing period": string;
@@ -12986,6 +13012,12 @@ declare interface PlanVersionResponseData {
12986
13012
  * @memberof PlanVersionResponseData
12987
13013
  */
12988
13014
  planType: PlanType;
13015
+ /**
13016
+ * Where the company moves at term end when renewal_policy is migrate_to_plan. Null for any other policy.
13017
+ * @type {RenewalDestinationResponseData}
13018
+ * @memberof PlanVersionResponseData
13019
+ */
13020
+ renewalDestination?: RenewalDestinationResponseData | null;
12989
13021
  /**
12990
13022
  *
12991
13023
  * @type {RenewalPolicy}
@@ -13066,6 +13098,12 @@ declare interface PlanVersionResponseData_2 {
13066
13098
  * @memberof PlanVersionResponseData
13067
13099
  */
13068
13100
  planType: PlanType_2;
13101
+ /**
13102
+ * Where the company moves at term end when renewal_policy is migrate_to_plan. Null for any other policy.
13103
+ * @type {RenewalDestinationResponseData}
13104
+ * @memberof PlanVersionResponseData
13105
+ */
13106
+ renewalDestination?: RenewalDestinationResponseData_2 | null;
13069
13107
  /**
13070
13108
  *
13071
13109
  * @type {RenewalPolicy}
@@ -13680,6 +13718,12 @@ declare interface PreviewSubscriptionChangeResponseData {
13680
13718
  * @deprecated
13681
13719
  */
13682
13720
  trialEnd?: Date | null;
13721
+ /**
13722
+ * Features whose usage so far this billing period is not billed if this change is made, because the new plan does not charge for them and the billing period continues.
13723
+ * @type {Array<string>}
13724
+ * @memberof PreviewSubscriptionChangeResponseData
13725
+ */
13726
+ unbilledUsageFeatureIds: Array<string>;
13683
13727
  /**
13684
13728
  *
13685
13729
  * @type {Array<FeatureUsageResponseData>}
@@ -14183,6 +14227,46 @@ export declare interface RehydrateParams {
14183
14227
  includeAddOnIds?: string[];
14184
14228
  }
14185
14229
 
14230
+ /**
14231
+ *
14232
+ * @export
14233
+ * @interface RenewalDestinationResponseData
14234
+ */
14235
+ declare interface RenewalDestinationResponseData {
14236
+ /**
14237
+ *
14238
+ * @type {PlanPriceCadence}
14239
+ * @memberof RenewalDestinationResponseData
14240
+ */
14241
+ billingPeriod: PlanPriceCadence;
14242
+ /**
14243
+ *
14244
+ * @type {string}
14245
+ * @memberof RenewalDestinationResponseData
14246
+ */
14247
+ planId: string;
14248
+ }
14249
+
14250
+ /**
14251
+ *
14252
+ * @export
14253
+ * @interface RenewalDestinationResponseData
14254
+ */
14255
+ declare interface RenewalDestinationResponseData_2 {
14256
+ /**
14257
+ *
14258
+ * @type {PlanPriceCadence}
14259
+ * @memberof RenewalDestinationResponseData
14260
+ */
14261
+ billingPeriod: PlanPriceCadence_2;
14262
+ /**
14263
+ *
14264
+ * @type {string}
14265
+ * @memberof RenewalDestinationResponseData
14266
+ */
14267
+ planId: string;
14268
+ }
14269
+
14186
14270
  /**
14187
14271
  *
14188
14272
  * @export
@@ -14191,6 +14275,7 @@ declare const RenewalPolicy: {
14191
14275
  readonly AutoRenew: "auto_renew";
14192
14276
  readonly ExpireToDefault: "expire_to_default";
14193
14277
  readonly HoldWithGrace: "hold_with_grace";
14278
+ readonly MigrateToPlan: "migrate_to_plan";
14194
14279
  };
14195
14280
 
14196
14281
  declare type RenewalPolicy = (typeof RenewalPolicy)[keyof typeof RenewalPolicy];
@@ -14203,6 +14288,7 @@ declare const RenewalPolicy_2: {
14203
14288
  readonly AutoRenew: "auto_renew";
14204
14289
  readonly ExpireToDefault: "expire_to_default";
14205
14290
  readonly HoldWithGrace: "hold_with_grace";
14291
+ readonly MigrateToPlan: "migrate_to_plan";
14206
14292
  };
14207
14293
 
14208
14294
  declare type RenewalPolicy_2 = (typeof RenewalPolicy_2)[keyof typeof RenewalPolicy_2];
@@ -14989,12 +15075,24 @@ declare interface ScheduledDowngradeResponseData {
14989
15075
  * @memberof ScheduledDowngradeResponseData
14990
15076
  */
14991
15077
  interval: string;
15078
+ /**
15079
+ * With interval, the current subscription's billing period: 3 with month is quarterly.
15080
+ * @type {number}
15081
+ * @memberof ScheduledDowngradeResponseData
15082
+ */
15083
+ intervalCount: number;
14992
15084
  /**
14993
15085
  *
14994
15086
  * @type {string}
14995
15087
  * @memberof ScheduledDowngradeResponseData
14996
15088
  */
14997
15089
  scheduledInterval?: string | null;
15090
+ /**
15091
+ * With scheduled_interval, the scheduled price's billing period: 3 with month is quarterly. Null for a downgrade scheduled before the price was recorded.
15092
+ * @type {number}
15093
+ * @memberof ScheduledDowngradeResponseData
15094
+ */
15095
+ scheduledIntervalCount?: number | null;
14998
15096
  /**
14999
15097
  *
15000
15098
  * @type {number}
@@ -15913,6 +16011,7 @@ export declare function useAvailablePlans(activePeriod: string, options?: Availa
15913
16011
  plans: SelectedPlan[];
15914
16012
  addOns: SelectedPlan[];
15915
16013
  periods: string[];
16014
+ plansForPeriod: (period: string) => SelectedPlan[];
15916
16015
  };
15917
16016
 
15918
16017
  export declare function useCustomPlanBilling(): CustomPlanBillingState | undefined;