@wix/auto_sdk_subscription_subscriptions 1.0.41 → 1.0.43

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.
Files changed (37) hide show
  1. package/build/cjs/index.d.ts +2 -2
  2. package/build/cjs/index.js +795 -91
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/index.typings.d.ts +690 -51
  5. package/build/cjs/index.typings.js +648 -0
  6. package/build/cjs/index.typings.js.map +1 -1
  7. package/build/cjs/meta.d.ts +666 -51
  8. package/build/cjs/meta.js +506 -0
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/index.d.mts +2 -2
  11. package/build/es/index.mjs +785 -91
  12. package/build/es/index.mjs.map +1 -1
  13. package/build/es/index.typings.d.mts +690 -51
  14. package/build/es/index.typings.mjs +638 -0
  15. package/build/es/index.typings.mjs.map +1 -1
  16. package/build/es/meta.d.mts +666 -51
  17. package/build/es/meta.mjs +496 -0
  18. package/build/es/meta.mjs.map +1 -1
  19. package/build/internal/cjs/index.d.ts +90 -4
  20. package/build/internal/cjs/index.js +795 -91
  21. package/build/internal/cjs/index.js.map +1 -1
  22. package/build/internal/cjs/index.typings.d.ts +766 -51
  23. package/build/internal/cjs/index.typings.js +648 -0
  24. package/build/internal/cjs/index.typings.js.map +1 -1
  25. package/build/internal/cjs/meta.d.ts +666 -51
  26. package/build/internal/cjs/meta.js +506 -0
  27. package/build/internal/cjs/meta.js.map +1 -1
  28. package/build/internal/es/index.d.mts +90 -4
  29. package/build/internal/es/index.mjs +785 -91
  30. package/build/internal/es/index.mjs.map +1 -1
  31. package/build/internal/es/index.typings.d.mts +766 -51
  32. package/build/internal/es/index.typings.mjs +638 -0
  33. package/build/internal/es/index.typings.mjs.map +1 -1
  34. package/build/internal/es/meta.d.mts +666 -51
  35. package/build/internal/es/meta.mjs +496 -0
  36. package/build/internal/es/meta.mjs.map +1 -1
  37. package/package.json +2 -2
@@ -852,6 +852,127 @@ interface SubscriptionPolicies {
852
852
  businessCanExtend?: boolean;
853
853
  /** Subscription can be canceled not only immediately, but also at end of billing cycle by turning off auto-renew */
854
854
  allowEndOfCycleCancellation?: boolean;
855
+ /**
856
+ * Per-subscription customer action settings. Controls which self-service actions
857
+ * customers can perform on this specific subscription.
858
+ * If not provided on creation, copied from site-level BillingSettings.
859
+ */
860
+ customerActionSettings?: CustomerActionSettings;
861
+ }
862
+ /**
863
+ * Per-action merchant configuration for customer self-service actions.
864
+ * All booleans use BoolValue (optional) so verticals can selectively override defaults.
865
+ */
866
+ interface CustomerActionSettings {
867
+ /** Skip cycle action settings */
868
+ skip?: SkipActionSettings;
869
+ /** Pause/resume action settings */
870
+ pauseResume?: PauseResumeActionSettings;
871
+ /** Cancel action settings */
872
+ cancel?: CancelActionSettings;
873
+ /** Update payment method action settings */
874
+ upm?: UpmActionSettings;
875
+ /** Update billing date action settings */
876
+ updateBillingDate?: UpdateBillingDateActionSettings;
877
+ }
878
+ /** Controls skip cycle functionality — lets a customer skip one or more billing cycles. */
879
+ interface SkipActionSettings {
880
+ /** Whether the skip action is enabled */
881
+ enabled?: boolean | null;
882
+ /** Skip action configuration */
883
+ configuration?: SkipActionConfiguration;
884
+ }
885
+ /** Configuration for the skip cycle action. */
886
+ interface SkipActionConfiguration {
887
+ /** Maximum number of billing cycles a customer can skip */
888
+ maxSkipCycles?: number | null;
889
+ /** Minimum days before billing date to allow skip */
890
+ daysBeforeSkipAllowed?: number | null;
891
+ /** Minimum days before billing date to allow resume from skip */
892
+ daysBeforeResumeAllowed?: number | null;
893
+ /** Minimum days before billing date to cancel a scheduled skip */
894
+ daysBeforeCancelSkipAllowed?: number | null;
895
+ /** Maximum number of times a customer can perform skip action */
896
+ maxSkipUserActions?: number | null;
897
+ /** Allow skipping the next billing cycle */
898
+ skipNextCycle?: boolean | null;
899
+ /** Allow skipping future billing cycles */
900
+ skipFutureCycles?: boolean | null;
901
+ /** Allow reversing a pending skip */
902
+ unskip?: boolean | null;
903
+ /** Allow cancelling a scheduled skip-pause */
904
+ cancelScheduledPause?: boolean | null;
905
+ /** Allow immediate resume from skip */
906
+ resumeImmediately?: boolean | null;
907
+ /** Allow resume at the next billing date */
908
+ resumeAtNextBillingDate?: boolean | null;
909
+ /** Allow resume at a specific date */
910
+ resumeAtSpecificDate?: boolean | null;
911
+ /** Allow setting auto-resume after N cycles */
912
+ autoResumeCycles?: boolean | null;
913
+ }
914
+ /**
915
+ * Subscription pause/resume settings — full pause of billing, not skip.
916
+ * Skip action (temporary pause for N cycles) is configured via SkipActionSettings.
917
+ */
918
+ interface PauseResumeActionSettings {
919
+ /** Whether the pause/resume action is enabled */
920
+ enabled?: boolean | null;
921
+ /** Pause/resume action configuration */
922
+ configuration?: PauseResumeActionConfiguration;
923
+ }
924
+ /**
925
+ * Configuration for the subscription pause/resume action.
926
+ * Skip action (temporary pause for N cycles) is configured via SkipActionConfiguration.
927
+ */
928
+ interface PauseResumeActionConfiguration {
929
+ /** Minimum days before billing date to allow pause */
930
+ daysBeforePauseAllowed?: number | null;
931
+ /** Maximum cycles for auto-resume after pause */
932
+ maxAutoResumeCycles?: number | null;
933
+ /** Minimum days before billing date to allow resume */
934
+ daysBeforeResumeAllowed?: number | null;
935
+ /** Minimum days before billing to cancel scheduled pause */
936
+ daysBeforeCancelScheduledPauseAllowed?: number | null;
937
+ /** Maximum number of times a customer can perform pause action */
938
+ maxPauseUserActions?: number | null;
939
+ }
940
+ /** Cancel subscription action settings. */
941
+ interface CancelActionSettings {
942
+ /** Whether the cancel action is enabled */
943
+ enabled?: boolean | null;
944
+ /** Cancel action configuration */
945
+ configuration?: CancelActionConfiguration;
946
+ }
947
+ /** Configuration for the cancel subscription action. */
948
+ interface CancelActionConfiguration {
949
+ /** Minimum days before period end to allow cancellation */
950
+ minDaysBeforePeriodEnd?: number | null;
951
+ }
952
+ /** Update Payment Method action settings — toggle only, no additional configuration. */
953
+ interface UpmActionSettings {
954
+ /** Whether the update payment method action is enabled */
955
+ enabled?: boolean | null;
956
+ }
957
+ /** Update billing date action settings. */
958
+ interface UpdateBillingDateActionSettings {
959
+ /** Whether the update billing date action is enabled */
960
+ enabled?: boolean | null;
961
+ /** Update billing date configuration */
962
+ configuration?: UpdateBillingDateActionConfiguration;
963
+ }
964
+ /** Configuration for the update billing date action. */
965
+ interface UpdateBillingDateActionConfiguration {
966
+ /** Whether to adjust price when billing date changes */
967
+ priceAdjustmentEnabled?: boolean | null;
968
+ /** Maximum days the billing date can be moved forward */
969
+ maxDaysAdvance?: number | null;
970
+ /** Maximum days the billing date can be postponed */
971
+ maxDaysPostpone?: number | null;
972
+ /** Minimum days from today for the new billing date */
973
+ minDaysFromToday?: number | null;
974
+ /** Whether to allow advancing billing date for weekly subscriptions */
975
+ allowAdvanceForWeekly?: boolean | null;
855
976
  }
856
977
  interface PauseInfo {
857
978
  pausePolicy?: PausePolicyWithLiterals;
@@ -1368,6 +1489,8 @@ interface CustomerAllowedActionsRequest {
1368
1489
  }
1369
1490
  interface CustomerAllowedActionsResponse {
1370
1491
  actions?: Action[];
1492
+ /** Enriched actions with per-action capability configuration for customer UI. */
1493
+ customerActions?: CustomerAction[];
1371
1494
  }
1372
1495
  interface Action {
1373
1496
  actionType?: ActionTypeWithLiterals;
@@ -1390,16 +1513,69 @@ declare enum ActionType {
1390
1513
  UPDATE_START_DATE = "UPDATE_START_DATE",
1391
1514
  UPM = "UPM",
1392
1515
  UPDATE_BILLING_DATE = "UPDATE_BILLING_DATE",
1393
- UPDATE_COLLECTION_METHOD = "UPDATE_COLLECTION_METHOD"
1516
+ UPDATE_COLLECTION_METHOD = "UPDATE_COLLECTION_METHOD",
1517
+ SKIP_CYCLE = "SKIP_CYCLE",
1518
+ CUSTOMER_UPDATE_BILLING_DATE = "CUSTOMER_UPDATE_BILLING_DATE"
1394
1519
  }
1395
1520
  /** @enumType */
1396
- type ActionTypeWithLiterals = ActionType | 'NONE' | 'CREATION' | 'CANCEL' | 'CYCLE_AUTO_RENEW_ON' | 'CYCLE_AUTO_RENEW_OFF' | 'PAUSE' | 'RESUME' | 'MARK_AS_PAID' | 'EXTEND' | 'UPDATE' | 'UPDATE_START_DATE' | 'UPM' | 'UPDATE_BILLING_DATE' | 'UPDATE_COLLECTION_METHOD';
1521
+ type ActionTypeWithLiterals = ActionType | 'NONE' | 'CREATION' | 'CANCEL' | 'CYCLE_AUTO_RENEW_ON' | 'CYCLE_AUTO_RENEW_OFF' | 'PAUSE' | 'RESUME' | 'MARK_AS_PAID' | 'EXTEND' | 'UPDATE' | 'UPDATE_START_DATE' | 'UPM' | 'UPDATE_BILLING_DATE' | 'UPDATE_COLLECTION_METHOD' | 'SKIP_CYCLE' | 'CUSTOMER_UPDATE_BILLING_DATE';
1397
1522
  declare enum ExtendPolicyType {
1398
1523
  PERIOD = "PERIOD",
1399
1524
  BILLING_CYCLE = "BILLING_CYCLE"
1400
1525
  }
1401
1526
  /** @enumType */
1402
1527
  type ExtendPolicyTypeWithLiterals = ExtendPolicyType | 'PERIOD' | 'BILLING_CYCLE';
1528
+ /**
1529
+ * Enriched action returned by the customer AllowedActions API.
1530
+ * Each action includes its type and, when applicable, capability configuration
1531
+ * that clients can use to build informed UIs (e.g., max skip cycles, max days to advance).
1532
+ * Actions without a matching configuration variant (e.g., CREATION, EXTEND) carry type only.
1533
+ */
1534
+ interface CustomerAction extends CustomerActionConfigurationOneOf {
1535
+ skip?: CustomerSkipConfiguration;
1536
+ pauseResume?: CustomerPauseResumeConfiguration;
1537
+ cancel?: CustomerCancelConfiguration;
1538
+ updateBillingDate?: CustomerUpdateBillingDateConfiguration;
1539
+ /** The type of customer action (e.g., CANCEL, SKIP_CYCLE, PAUSE). */
1540
+ actionType?: ActionTypeWithLiterals;
1541
+ }
1542
+ /** @oneof */
1543
+ interface CustomerActionConfigurationOneOf {
1544
+ skip?: CustomerSkipConfiguration;
1545
+ pauseResume?: CustomerPauseResumeConfiguration;
1546
+ cancel?: CustomerCancelConfiguration;
1547
+ updateBillingDate?: CustomerUpdateBillingDateConfiguration;
1548
+ }
1549
+ /** Capability configuration for skip cycle action. */
1550
+ interface CustomerSkipConfiguration {
1551
+ /** Maximum number of billing cycles a customer can skip. Null if unlimited. */
1552
+ maxSkipCycles?: number | null;
1553
+ /** Whether the customer can skip the next upcoming cycle. */
1554
+ skipNextCycle?: boolean | null;
1555
+ /** Whether the customer can skip future (non-next) cycles. */
1556
+ skipFutureCycles?: boolean | null;
1557
+ /** Whether the customer can cancel a previously scheduled skip. */
1558
+ unskip?: boolean | null;
1559
+ /** Whether auto-resume after skipped cycles is enabled. */
1560
+ autoResumeEnabled?: boolean | null;
1561
+ }
1562
+ /** Capability configuration for pause/resume actions. */
1563
+ interface CustomerPauseResumeConfiguration {
1564
+ /** Maximum number of cycles after which a paused subscription auto-resumes. Null if unlimited. */
1565
+ maxAutoResumeCycles?: number | null;
1566
+ }
1567
+ /** Capability configuration for cancel action (reserved for future use). */
1568
+ interface CustomerCancelConfiguration {
1569
+ }
1570
+ /** Capability configuration for update billing date action. */
1571
+ interface CustomerUpdateBillingDateConfiguration {
1572
+ /** Whether price adjustment (proration) is enabled when changing the billing date. */
1573
+ priceAdjustmentEnabled?: boolean | null;
1574
+ /** Maximum number of days the billing date can be moved earlier. */
1575
+ maxDaysAdvance?: number | null;
1576
+ /** Maximum number of days the billing date can be postponed. */
1577
+ maxDaysPostpone?: number | null;
1578
+ }
1403
1579
  interface CustomerListUpcomingChargesRequest {
1404
1580
  /**
1405
1581
  * Subscription id upcoming charge to be previewed for
@@ -1747,6 +1923,143 @@ interface InitiatePaymentMethodSetupResponse {
1747
1923
  /** @format GUID */
1748
1924
  paymentOrderId?: string;
1749
1925
  }
1926
+ interface CustomerSkipCycleRequest {
1927
+ /**
1928
+ * ID of the subscription to skip cycles for.
1929
+ * @format GUID
1930
+ */
1931
+ _id: string;
1932
+ /** Number of billing cycles to skip. */
1933
+ cyclesToSkip: number | null;
1934
+ /** When to start the skip. Contains number of cycles from next billing date. */
1935
+ pauseAtSchedule?: ScheduleAdditionalInfo;
1936
+ /** Auto-resume scheduling information. Contains number of cycles from pause start. */
1937
+ autoResumeAtSchedule?: ScheduleAdditionalInfo;
1938
+ /** Optional reason for the skip. */
1939
+ reason?: string | null;
1940
+ }
1941
+ interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
1942
+ /**
1943
+ * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
1944
+ * format. The use of this field may be restricted in various BASS endpoints.
1945
+ * For example, in _Bulk Update Subscription Items_ it's only available in
1946
+ * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
1947
+ * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
1948
+ * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
1949
+ */
1950
+ specificDate?: Date | null;
1951
+ /**
1952
+ * When the update becomes effective, as number of billing cycles from now.
1953
+ * The use of this field may be restricted in various BASS endpoints.
1954
+ * For example, in _Pause Subscription_ it's only available in
1955
+ * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
1956
+ * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
1957
+ * @min 1
1958
+ * @max 120
1959
+ */
1960
+ numberOfCycles?: number;
1961
+ }
1962
+ /** @oneof */
1963
+ interface ScheduleAdditionalInfoParamOneOf {
1964
+ /**
1965
+ * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
1966
+ * format. The use of this field may be restricted in various BASS endpoints.
1967
+ * For example, in _Bulk Update Subscription Items_ it's only available in
1968
+ * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
1969
+ * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
1970
+ * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
1971
+ */
1972
+ specificDate?: Date | null;
1973
+ /**
1974
+ * When the update becomes effective, as number of billing cycles from now.
1975
+ * The use of this field may be restricted in various BASS endpoints.
1976
+ * For example, in _Pause Subscription_ it's only available in
1977
+ * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
1978
+ * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
1979
+ * @min 1
1980
+ * @max 120
1981
+ */
1982
+ numberOfCycles?: number;
1983
+ }
1984
+ interface CustomerSkipCycleResponse {
1985
+ subscription?: Subscription;
1986
+ }
1987
+ interface CustomerCancelScheduledSkipRequest {
1988
+ /**
1989
+ * ID of the subscription to cancel the scheduled skip for.
1990
+ * @format GUID
1991
+ */
1992
+ _id: string;
1993
+ /** Optional reason for canceling the scheduled skip. */
1994
+ reason?: string | null;
1995
+ }
1996
+ interface CustomerCancelScheduledSkipResponse {
1997
+ subscription?: Subscription;
1998
+ }
1999
+ interface CustomerPauseSubscriptionRequest {
2000
+ /**
2001
+ * ID of the subscription to pause.
2002
+ * @format GUID
2003
+ */
2004
+ _id: string;
2005
+ /** Pause policy to apply. */
2006
+ pausePolicy?: PausePolicyWithLiterals;
2007
+ /** Optional reason for the pause. */
2008
+ reason?: string | null;
2009
+ /** When to pause. For example, IMMEDIATELY or NEXT_BILLING_DATE. */
2010
+ pauseAt?: PauseAtWithLiterals;
2011
+ /** Additional scheduling information for certain pause_at options. */
2012
+ pauseAtSchedule?: ScheduleAdditionalInfo;
2013
+ /** Auto-resume scheduling information. */
2014
+ autoResumeAtSchedule?: ScheduleAdditionalInfo;
2015
+ }
2016
+ interface CustomerPauseSubscriptionResponse {
2017
+ subscription?: Subscription;
2018
+ }
2019
+ interface CustomerResumeSubscriptionRequest {
2020
+ /**
2021
+ * ID of the subscription to resume.
2022
+ * @format GUID
2023
+ */
2024
+ _id: string;
2025
+ /** Optional reason for the resume. */
2026
+ reason?: string | null;
2027
+ /** When to resume. For example, IMMEDIATELY or NEXT_BILLING_DATE. */
2028
+ resumeAt?: ResumeAtWithLiterals;
2029
+ /** Additional scheduling information for certain resume_at options. */
2030
+ resumeAtSchedule?: ScheduleAdditionalInfo;
2031
+ }
2032
+ interface CustomerResumeSubscriptionResponse {
2033
+ subscription?: Subscription;
2034
+ }
2035
+ interface CustomerCancelScheduledPauseRequest {
2036
+ /**
2037
+ * ID of the subscription to cancel the scheduled pause for.
2038
+ * @format GUID
2039
+ */
2040
+ _id: string;
2041
+ /** Optional reason for canceling the scheduled pause. */
2042
+ reason?: string | null;
2043
+ }
2044
+ interface CustomerCancelScheduledPauseResponse {
2045
+ subscription?: Subscription;
2046
+ }
2047
+ interface CustomerUpdateBillingDateRequest {
2048
+ /**
2049
+ * ID of the subscription to update the billing date for.
2050
+ * @format GUID
2051
+ */
2052
+ _id: string;
2053
+ /** New billing date. */
2054
+ billingDate: Date | null;
2055
+ /** Optional proration settings. */
2056
+ proration?: Proration;
2057
+ /** Optional reason for the update. */
2058
+ reason?: string | null;
2059
+ }
2060
+ interface CustomerUpdateBillingDateResponse {
2061
+ subscription?: Subscription;
2062
+ }
1750
2063
  interface DomainEvent extends DomainEventBodyOneOf {
1751
2064
  createdEvent?: EntityCreatedEvent;
1752
2065
  updatedEvent?: EntityUpdatedEvent;
@@ -2587,49 +2900,6 @@ declare enum UpdateAction {
2587
2900
  }
2588
2901
  /** @enumType */
2589
2902
  type UpdateActionWithLiterals = UpdateAction | 'NONE' | 'IMMEDIATELY' | 'NEXT_BILLING_CYCLE' | 'RESET_PENDING_UPDATES' | 'SPECIFIC_DATE';
2590
- interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
2591
- /**
2592
- * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
2593
- * format. The use of this field may be restricted in various BASS endpoints.
2594
- * For example, in _Bulk Update Subscription Items_ it's only available in
2595
- * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
2596
- * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
2597
- * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
2598
- */
2599
- specificDate?: Date | null;
2600
- /**
2601
- * When the update becomes effective, as number of billing cycles from now.
2602
- * The use of this field may be restricted in various BASS endpoints.
2603
- * For example, in _Pause Subscription_ it's only available in
2604
- * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
2605
- * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
2606
- * @min 1
2607
- * @max 120
2608
- */
2609
- numberOfCycles?: number;
2610
- }
2611
- /** @oneof */
2612
- interface ScheduleAdditionalInfoParamOneOf {
2613
- /**
2614
- * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
2615
- * format. The use of this field may be restricted in various BASS endpoints.
2616
- * For example, in _Bulk Update Subscription Items_ it's only available in
2617
- * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
2618
- * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
2619
- * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
2620
- */
2621
- specificDate?: Date | null;
2622
- /**
2623
- * When the update becomes effective, as number of billing cycles from now.
2624
- * The use of this field may be restricted in various BASS endpoints.
2625
- * For example, in _Pause Subscription_ it's only available in
2626
- * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
2627
- * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
2628
- * @min 1
2629
- * @max 120
2630
- */
2631
- numberOfCycles?: number;
2632
- }
2633
2903
  interface UpdateSubscriptionItemsResponse {
2634
2904
  subscription?: Subscription;
2635
2905
  }
@@ -3227,10 +3497,11 @@ declare enum InvoiceStatus {
3227
3497
  FAILED = "FAILED",
3228
3498
  ATTEMPT_FAILED = "ATTEMPT_FAILED",
3229
3499
  CANCELED = "CANCELED",
3230
- REFUNDED = "REFUNDED"
3500
+ REFUNDED = "REFUNDED",
3501
+ CHARGEBACKED = "CHARGEBACKED"
3231
3502
  }
3232
3503
  /** @enumType */
3233
- type InvoiceStatusWithLiterals = InvoiceStatus | 'UNKNOWN' | 'OPEN' | 'PAID' | 'FAILED' | 'ATTEMPT_FAILED' | 'CANCELED' | 'REFUNDED';
3504
+ type InvoiceStatusWithLiterals = InvoiceStatus | 'UNKNOWN' | 'OPEN' | 'PAID' | 'FAILED' | 'ATTEMPT_FAILED' | 'CANCELED' | 'REFUNDED' | 'CHARGEBACKED';
3234
3505
  declare enum CollectionMethod {
3235
3506
  UNKNOWN = "UNKNOWN",
3236
3507
  AUTO_CHARGE = "AUTO_CHARGE",
@@ -3294,15 +3565,19 @@ declare enum PaymentAttemptStatus {
3294
3565
  DECLINED = "DECLINED",
3295
3566
  TECHNICAL_FAILURE = "TECHNICAL_FAILURE",
3296
3567
  CANCELED = "CANCELED",
3297
- PENDING = "PENDING"
3568
+ PENDING = "PENDING",
3569
+ REFUNDED = "REFUNDED",
3570
+ CHARGEBACKED = "CHARGEBACKED"
3298
3571
  }
3299
3572
  /** @enumType */
3300
- type PaymentAttemptStatusWithLiterals = PaymentAttemptStatus | 'UNKNOWN' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAID' | 'DECLINED' | 'TECHNICAL_FAILURE' | 'CANCELED' | 'PENDING';
3573
+ type PaymentAttemptStatusWithLiterals = PaymentAttemptStatus | 'UNKNOWN' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAID' | 'DECLINED' | 'TECHNICAL_FAILURE' | 'CANCELED' | 'PENDING' | 'REFUNDED' | 'CHARGEBACKED';
3301
3574
  interface PriceAdjustment extends PriceAdjustmentAdjustmentTypeOneOf {
3302
3575
  /** Adjustment that increases the price. */
3303
3576
  charge?: PriceAdjustmentValue;
3304
3577
  /** Adjustment that lowers the price. */
3305
3578
  credit?: PriceAdjustmentValue;
3579
+ /** Reason for this price adjustment. Used to categorize proration adjustments. */
3580
+ reason?: PriceAdjustmentReasonWithLiterals;
3306
3581
  }
3307
3582
  /** @oneof */
3308
3583
  interface PriceAdjustmentAdjustmentTypeOneOf {
@@ -3354,6 +3629,23 @@ interface PriceAdjustmentValueAdjustmentValueTypeOneOf {
3354
3629
  */
3355
3630
  multiplier?: string;
3356
3631
  }
3632
+ /** Reason for a price adjustment. Categorizes different types of proration adjustments. */
3633
+ declare enum PriceAdjustmentReason {
3634
+ /** Default value. Used for adjustments without a specific categorization. */
3635
+ PRICE_ADJUSTMENT_REASON_UNSPECIFIED = "PRICE_ADJUSTMENT_REASON_UNSPECIFIED",
3636
+ /** Adjustment due to a billing date change. */
3637
+ BILLING_DATE_CHANGE = "BILLING_DATE_CHANGE",
3638
+ /** Proration adjustment from changing the subscription plan. */
3639
+ PLAN_CHANGE_PRORATION = "PLAN_CHANGE_PRORATION",
3640
+ /** Proration adjustment from changing the billing cycle (e.g., monthly to yearly). */
3641
+ CYCLE_CHANGE_PRORATION = "CYCLE_CHANGE_PRORATION",
3642
+ /** Proration adjustment from changing the subscription quantity. */
3643
+ QUANTITY_CHANGE_PRORATION = "QUANTITY_CHANGE_PRORATION",
3644
+ /** Custom adjustment provided by the caller. */
3645
+ CUSTOM_PRICE_ADJUSTMENT = "CUSTOM_PRICE_ADJUSTMENT"
3646
+ }
3647
+ /** @enumType */
3648
+ type PriceAdjustmentReasonWithLiterals = PriceAdjustmentReason | 'PRICE_ADJUSTMENT_REASON_UNSPECIFIED' | 'BILLING_DATE_CHANGE' | 'PLAN_CHANGE_PRORATION' | 'CYCLE_CHANGE_PRORATION' | 'QUANTITY_CHANGE_PRORATION' | 'CUSTOM_PRICE_ADJUSTMENT';
3357
3649
  interface InvoiceShippingCharges {
3358
3650
  /**
3359
3651
  * Amount of the shipping fee in `0.00` format.
@@ -3460,6 +3752,227 @@ declare enum RefundReason {
3460
3752
  }
3461
3753
  /** @enumType */
3462
3754
  type RefundReasonWithLiterals = RefundReason | 'UNKNOWN_REFUND_REASON' | 'DUPLICATE_CHARGE' | 'FRAUDULENT' | 'CUSTOMER_REQUEST' | 'PROVISION_FAILED' | 'OTHER';
3755
+ interface ChangeSubscriptionRequest {
3756
+ /**
3757
+ * ID of the subscription to change
3758
+ * @format GUID
3759
+ */
3760
+ subscriptionId?: string;
3761
+ /** New product ID. Set to change the subscription plan. */
3762
+ newProductId?: string | null;
3763
+ /** New billing cycle duration. Set to change the billing cycle (e.g., monthly to yearly). */
3764
+ newCycle?: Duration;
3765
+ /**
3766
+ * New quantity. Set to change the number of units (seats/licenses).
3767
+ * @min 1
3768
+ */
3769
+ newQuantity?: number | null;
3770
+ /** When the change takes effect. */
3771
+ effectiveTime?: ChangeEffectiveTimeWithLiterals;
3772
+ /** How to handle proration for immediate changes. Ignored for AT_NEXT_RENEWAL. */
3773
+ prorationBehavior?: ProrationBehaviorWithLiterals;
3774
+ /** Payment context for immediate changes without checkout flow. */
3775
+ paymentContext?: ChangePaymentContext;
3776
+ }
3777
+ declare enum ChangeEffectiveTime {
3778
+ UNKNOWN = "UNKNOWN",
3779
+ /** Apply change immediately with proration */
3780
+ IMMEDIATELY = "IMMEDIATELY",
3781
+ /** Schedule change for the next billing cycle */
3782
+ AT_NEXT_RENEWAL = "AT_NEXT_RENEWAL"
3783
+ }
3784
+ /** @enumType */
3785
+ type ChangeEffectiveTimeWithLiterals = ChangeEffectiveTime | 'UNKNOWN' | 'IMMEDIATELY' | 'AT_NEXT_RENEWAL';
3786
+ declare enum ProrationBehavior {
3787
+ UNKNOWN = "UNKNOWN",
3788
+ /** Credit unused time + charge new prorated price (default for upgrades) */
3789
+ PRORATE_AND_CHARGE = "PRORATE_AND_CHARGE",
3790
+ /** Credit unused time + refund to payment method (downgrades) */
3791
+ PRORATE_AND_REFUND = "PRORATE_AND_REFUND",
3792
+ /** Convert unused value to extra days, no financial transaction */
3793
+ PRORATE_AND_EXTEND = "PRORATE_AND_EXTEND",
3794
+ /** Immediate switch with no financial adjustment */
3795
+ NO_PRORATION = "NO_PRORATION"
3796
+ }
3797
+ /** @enumType */
3798
+ type ProrationBehaviorWithLiterals = ProrationBehavior | 'UNKNOWN' | 'PRORATE_AND_CHARGE' | 'PRORATE_AND_REFUND' | 'PRORATE_AND_EXTEND' | 'NO_PRORATION';
3799
+ /** Payment context for immediate subscription changes without the checkout flow. */
3800
+ interface ChangePaymentContext {
3801
+ /** Payment settings override for this change */
3802
+ paymentSettings?: PaymentSettings;
3803
+ }
3804
+ interface ChangeSubscriptionResponse {
3805
+ /** Updated subscription */
3806
+ subscription?: Subscription;
3807
+ /** Proration calculation result. Present for immediate changes with proration. */
3808
+ prorationResult?: ProrationResult;
3809
+ /**
3810
+ * ID of the adjustment invoice created for the proration charge or refund.
3811
+ * @format GUID
3812
+ */
3813
+ adjustmentInvoiceId?: string | null;
3814
+ }
3815
+ /** Result of a proration calculation applied during a subscription change. */
3816
+ interface ProrationResult {
3817
+ /**
3818
+ * Credit amount for unused time on the current plan
3819
+ * @format DECIMAL_VALUE
3820
+ */
3821
+ creditAmount?: string;
3822
+ /**
3823
+ * Charge amount for the new plan's prorated price
3824
+ * @format DECIMAL_VALUE
3825
+ */
3826
+ chargeAmount?: string;
3827
+ /**
3828
+ * Net amount (charge minus credit). Positive means customer pays, negative means refund.
3829
+ * @format DECIMAL_VALUE
3830
+ */
3831
+ netAmount?: string;
3832
+ /** Date when the proration was calculated */
3833
+ prorationDate?: Date | null;
3834
+ /** Remaining seconds in the current billing period at time of change */
3835
+ remainingSeconds?: string;
3836
+ /** Total seconds in the current billing cycle */
3837
+ totalCycleSeconds?: string;
3838
+ }
3839
+ interface PreviewChangeSubscriptionRequest {
3840
+ /**
3841
+ * ID of the subscription to preview the change for
3842
+ * @format GUID
3843
+ */
3844
+ subscriptionId?: string;
3845
+ /** New product ID. Set to preview a plan change. */
3846
+ newProductId?: string | null;
3847
+ /** New billing cycle duration. Set to preview a cycle change. */
3848
+ newCycle?: Duration;
3849
+ /**
3850
+ * New quantity. Set to preview a quantity change.
3851
+ * @min 1
3852
+ */
3853
+ newQuantity?: number | null;
3854
+ /** When the change would take effect. */
3855
+ effectiveTime?: ChangeEffectiveTimeWithLiterals;
3856
+ /** How proration would be handled for immediate changes. */
3857
+ prorationBehavior?: ProrationBehaviorWithLiterals;
3858
+ }
3859
+ interface PreviewChangeSubscriptionResponse {
3860
+ /** Summary of the current subscription state */
3861
+ current?: SubscriptionChangeSummary;
3862
+ /** Summary of the proposed subscription state after the change */
3863
+ proposed?: SubscriptionChangeSummary;
3864
+ /** Proration preview details. Present only for immediate changes. */
3865
+ proration?: ProrationPreview;
3866
+ /** Renewal preview. Present only for changes at next renewal. */
3867
+ renewalPreview?: RenewalPreview;
3868
+ }
3869
+ /** Summary of a subscription's state, used in change previews. */
3870
+ interface SubscriptionChangeSummary {
3871
+ /** Product ID */
3872
+ productId?: string;
3873
+ /** Product name */
3874
+ productName?: string;
3875
+ /** Billing cycle duration */
3876
+ cycle?: Duration;
3877
+ /** Number of units */
3878
+ quantity?: number;
3879
+ /**
3880
+ * Price per unit
3881
+ * @format DECIMAL_VALUE
3882
+ */
3883
+ pricePerUnit?: string;
3884
+ /**
3885
+ * Total price (price_per_unit * quantity)
3886
+ * @format DECIMAL_VALUE
3887
+ */
3888
+ totalPrice?: string;
3889
+ /**
3890
+ * Currency code (ISO 4217)
3891
+ * @format CURRENCY
3892
+ */
3893
+ currency?: string;
3894
+ /** Current billing period start */
3895
+ periodStart?: Date | null;
3896
+ /** Current billing period end */
3897
+ periodEnd?: Date | null;
3898
+ }
3899
+ /** Preview of proration amounts for a proposed subscription change. */
3900
+ interface ProrationPreview {
3901
+ /**
3902
+ * Credit amount for unused time on the current plan
3903
+ * @format DECIMAL_VALUE
3904
+ */
3905
+ creditAmount?: string;
3906
+ /**
3907
+ * Charge amount for the new plan's prorated price
3908
+ * @format DECIMAL_VALUE
3909
+ */
3910
+ chargeAmount?: string;
3911
+ /**
3912
+ * Net amount (charge minus credit)
3913
+ * @format DECIMAL_VALUE
3914
+ */
3915
+ netAmount?: string;
3916
+ /**
3917
+ * Tax amount on the net proration
3918
+ * @format DECIMAL_VALUE
3919
+ */
3920
+ taxAmount?: string;
3921
+ /**
3922
+ * Total amount including tax
3923
+ * @format DECIMAL_VALUE
3924
+ */
3925
+ totalAmount?: string;
3926
+ /** Remaining seconds in the current billing period */
3927
+ remainingSeconds?: string;
3928
+ /** Total seconds in the current billing cycle */
3929
+ totalCycleSeconds?: string;
3930
+ /** New period end date. Present when proration_behavior is PRORATE_AND_EXTEND. */
3931
+ newPeriodEnd?: Date | null;
3932
+ /** Number of days added to the billing period. Present when proration_behavior is PRORATE_AND_EXTEND. */
3933
+ daysAdded?: number;
3934
+ /** The proration action that would be taken */
3935
+ action?: ProrationActionWithLiterals;
3936
+ }
3937
+ declare enum ProrationAction {
3938
+ UNKNOWN = "UNKNOWN",
3939
+ /** Net charge to customer */
3940
+ CHARGE = "CHARGE",
3941
+ /** Net refund to customer */
3942
+ REFUND = "REFUND",
3943
+ /** Extend billing period instead of refund */
3944
+ EXTEND_PERIOD = "EXTEND_PERIOD",
3945
+ /** No financial change needed */
3946
+ NO_CHANGE = "NO_CHANGE"
3947
+ }
3948
+ /** @enumType */
3949
+ type ProrationActionWithLiterals = ProrationAction | 'UNKNOWN' | 'CHARGE' | 'REFUND' | 'EXTEND_PERIOD' | 'NO_CHANGE';
3950
+ /** Preview of what the next renewal will look like after a change. */
3951
+ interface RenewalPreview {
3952
+ /**
3953
+ * New price per unit at next renewal
3954
+ * @format DECIMAL_VALUE
3955
+ */
3956
+ newPrice?: string;
3957
+ /**
3958
+ * New total at next renewal (price * quantity)
3959
+ * @format DECIMAL_VALUE
3960
+ */
3961
+ newTotal?: string;
3962
+ /** Date of the next renewal */
3963
+ nextRenewalDate?: Date | null;
3964
+ }
3965
+ interface CancelPendingChangeRequest {
3966
+ /**
3967
+ * ID of the subscription to cancel the pending change for
3968
+ * @format GUID
3969
+ */
3970
+ subscriptionId?: string;
3971
+ }
3972
+ interface CancelPendingChangeResponse {
3973
+ /** Updated subscription with cleared pending data */
3974
+ subscription?: Subscription;
3975
+ }
3463
3976
  interface Task {
3464
3977
  key?: TaskKey;
3465
3978
  executeAt?: Date | null;
@@ -4043,6 +4556,90 @@ type CustomerExtendSubscriptionApplicationErrors = {
4043
4556
  data?: Record<string, any>;
4044
4557
  };
4045
4558
  /** @docsIgnore */
4559
+ type CustomerSkipCycleApplicationErrors = {
4560
+ code?: 'CUSTOMER_ACTION_NOT_ENABLED';
4561
+ description?: string;
4562
+ data?: Record<string, any>;
4563
+ } | {
4564
+ code?: 'CUSTOMER_TIMING_RESTRICTION';
4565
+ description?: string;
4566
+ data?: Record<string, any>;
4567
+ } | {
4568
+ code?: 'CUSTOMER_CONFIGURATION_ERROR';
4569
+ description?: string;
4570
+ data?: Record<string, any>;
4571
+ };
4572
+ /** @docsIgnore */
4573
+ type CustomerCancelScheduledSkipApplicationErrors = {
4574
+ code?: 'CUSTOMER_ACTION_NOT_ENABLED';
4575
+ description?: string;
4576
+ data?: Record<string, any>;
4577
+ } | {
4578
+ code?: 'CUSTOMER_TIMING_RESTRICTION';
4579
+ description?: string;
4580
+ data?: Record<string, any>;
4581
+ } | {
4582
+ code?: 'CUSTOMER_CONFIGURATION_ERROR';
4583
+ description?: string;
4584
+ data?: Record<string, any>;
4585
+ };
4586
+ /** @docsIgnore */
4587
+ type CustomerPauseSubscriptionApplicationErrors = {
4588
+ code?: 'CUSTOMER_ACTION_NOT_ENABLED';
4589
+ description?: string;
4590
+ data?: Record<string, any>;
4591
+ } | {
4592
+ code?: 'CUSTOMER_TIMING_RESTRICTION';
4593
+ description?: string;
4594
+ data?: Record<string, any>;
4595
+ } | {
4596
+ code?: 'CUSTOMER_CONFIGURATION_ERROR';
4597
+ description?: string;
4598
+ data?: Record<string, any>;
4599
+ };
4600
+ /** @docsIgnore */
4601
+ type CustomerResumeSubscriptionApplicationErrors = {
4602
+ code?: 'CUSTOMER_ACTION_NOT_ENABLED';
4603
+ description?: string;
4604
+ data?: Record<string, any>;
4605
+ } | {
4606
+ code?: 'CUSTOMER_TIMING_RESTRICTION';
4607
+ description?: string;
4608
+ data?: Record<string, any>;
4609
+ } | {
4610
+ code?: 'CUSTOMER_CONFIGURATION_ERROR';
4611
+ description?: string;
4612
+ data?: Record<string, any>;
4613
+ };
4614
+ /** @docsIgnore */
4615
+ type CustomerCancelScheduledPauseApplicationErrors = {
4616
+ code?: 'CUSTOMER_ACTION_NOT_ENABLED';
4617
+ description?: string;
4618
+ data?: Record<string, any>;
4619
+ } | {
4620
+ code?: 'CUSTOMER_TIMING_RESTRICTION';
4621
+ description?: string;
4622
+ data?: Record<string, any>;
4623
+ } | {
4624
+ code?: 'CUSTOMER_CONFIGURATION_ERROR';
4625
+ description?: string;
4626
+ data?: Record<string, any>;
4627
+ };
4628
+ /** @docsIgnore */
4629
+ type CustomerUpdateBillingDateApplicationErrors = {
4630
+ code?: 'CUSTOMER_ACTION_NOT_ENABLED';
4631
+ description?: string;
4632
+ data?: Record<string, any>;
4633
+ } | {
4634
+ code?: 'CUSTOMER_TIMING_RESTRICTION';
4635
+ description?: string;
4636
+ data?: Record<string, any>;
4637
+ } | {
4638
+ code?: 'CUSTOMER_CONFIGURATION_ERROR';
4639
+ description?: string;
4640
+ data?: Record<string, any>;
4641
+ };
4642
+ /** @docsIgnore */
4046
4643
  type UpdateSubscriptionBillingDateApplicationErrors = {
4047
4644
  code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
4048
4645
  description?: string;
@@ -4494,7 +5091,7 @@ declare function customerUpdateSubscriptionPaymentMethod(_id: string, paymentMet
4494
5091
  * @requiredField _id
4495
5092
  * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.AllowedActions
4496
5093
  */
4497
- declare function customerAllowedActions(_id: string): Promise<NonNullablePaths<CustomerAllowedActionsResponse, `actions` | `actions.${number}.actionType`, 4>>;
5094
+ declare function customerAllowedActions(_id: string): Promise<NonNullablePaths<CustomerAllowedActionsResponse, `actions` | `actions.${number}.actionType` | `customerActions` | `customerActions.${number}.actionType`, 4>>;
4498
5095
  /**
4499
5096
  * List future subscriptions charges.
4500
5097
  * @param _id - Subscription id upcoming charge to be previewed for
@@ -4516,6 +5113,48 @@ interface CustomerInitiatePaymentMethodSetupOptions {
4516
5113
  paymentMode?: PaymentModeWithLiterals;
4517
5114
  paymentSettings?: PaymentSettings;
4518
5115
  }
5116
+ interface CustomerSkipCycleOptions {
5117
+ /** When to start the skip. Contains number of cycles from next billing date. */
5118
+ pauseAtSchedule?: ScheduleAdditionalInfo;
5119
+ /** Auto-resume scheduling information. Contains number of cycles from pause start. */
5120
+ autoResumeAtSchedule?: ScheduleAdditionalInfo;
5121
+ /** Optional reason for the skip. */
5122
+ reason?: string | null;
5123
+ }
5124
+ interface CustomerCancelScheduledSkipOptions {
5125
+ /** Optional reason for canceling the scheduled skip. */
5126
+ reason?: string | null;
5127
+ }
5128
+ interface CustomerPauseSubscriptionOptions {
5129
+ /** Pause policy to apply. */
5130
+ pausePolicy?: PausePolicyWithLiterals;
5131
+ /** Optional reason for the pause. */
5132
+ reason?: string | null;
5133
+ /** When to pause. For example, IMMEDIATELY or NEXT_BILLING_DATE. */
5134
+ pauseAt?: PauseAtWithLiterals;
5135
+ /** Additional scheduling information for certain pause_at options. */
5136
+ pauseAtSchedule?: ScheduleAdditionalInfo;
5137
+ /** Auto-resume scheduling information. */
5138
+ autoResumeAtSchedule?: ScheduleAdditionalInfo;
5139
+ }
5140
+ interface CustomerResumeSubscriptionOptions {
5141
+ /** Optional reason for the resume. */
5142
+ reason?: string | null;
5143
+ /** When to resume. For example, IMMEDIATELY or NEXT_BILLING_DATE. */
5144
+ resumeAt?: ResumeAtWithLiterals;
5145
+ /** Additional scheduling information for certain resume_at options. */
5146
+ resumeAtSchedule?: ScheduleAdditionalInfo;
5147
+ }
5148
+ interface CustomerCancelScheduledPauseOptions {
5149
+ /** Optional reason for canceling the scheduled pause. */
5150
+ reason?: string | null;
5151
+ }
5152
+ interface CustomerUpdateBillingDateOptions {
5153
+ /** Optional proration settings. */
5154
+ proration?: Proration;
5155
+ /** Optional reason for the update. */
5156
+ reason?: string | null;
5157
+ }
4519
5158
  /**
4520
5159
  * This used only for automation and permitted tenants (QA & testing)
4521
5160
  * @public
@@ -4942,4 +5581,4 @@ interface ListSubscriptionHistoryOptions {
4942
5581
  cursor?: CursorPaging;
4943
5582
  }
4944
5583
 
4945
- export { type AbsorbFeeConfig, type AbsorbFeeConfigValueOneOf, type AccountInfo, type AccountInfoMetadata, type Action, type ActionContext, type ActionDetails, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, ActionType, type ActionTypeWithLiterals, type AddPausePeriodRequest, type AddPausePeriodResponse, type AdditionalFee, AdditionalFeeTrigger, type AdditionalFeeTriggerWithLiterals, type Address, type AddressStreetOneOf, type AggregatedTaxBreakdown, type AllowedActionsOptions, type AllowedActionsRequest, type AllowedActionsResponse, type AmountByStatus, type ApplicationFee, type ApplicationFeeValueOneOf, type AttachInvoice, type AutomaticRetryData, type BaseEventMetadata, type BassToSapiPaypalMigrationRequest, type BassToSapiPaypalMigrationResponse, type BillingSettings, type BillingStatus, type BulkItemChange, type BulkUpdateSubscriptionItemsByFilterRequest, type BulkUpdateSubscriptionItemsByFilterResponse, type BusinessOrigin, type BusinessOriginData, type Cancel, type CancelSubscriptionApplicationErrors, type CancelSubscriptionBORequest, type CancelSubscriptionBOResponse, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CancelTimeCapsuleTaskRequest, type CancellationInfo, CancellationInitiator, type CancellationInitiatorWithLiterals, type CatalogReference, type Charge, CollectionMethod, CollectionMethodEnumCollectionMethod, type CollectionMethodEnumCollectionMethodWithLiterals, type CollectionMethodWithLiterals, type Complete, type ConvertSapiRequest, type ConvertSapiResponse, type CountByStatus, type CountSubscriptionFilter, type CountSubscriptionFilterStatusOneOf, type CountSubscriptionsOptions, type CountSubscriptionsRequest, type CountSubscriptionsResponse, type CreateRecurringInvoiceBORequest, type CreateRecurringInvoiceBOResponse, type CreateSubscriptionForOrderRequest, type CreateSubscriptionForOrderResponse, type CreateSubscriptionInStateRequest, type CreateSubscriptionInStateRequestModeOneOf, type CreateSubscriptionInStateResponse, type CreateSubscriptionRequest, type CreateSubscriptionResponse, CreationMode, type CreationModeWithLiterals, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomBillingSchedule, type CustomProration, type CustomProrationAmountOneOf, type Customer, type CustomerAllowedActionsRequest, type CustomerAllowedActionsResponse, type CustomerCancelSubscriptionApplicationErrors, type CustomerCancelSubscriptionOptions, type CustomerCancelSubscriptionRequest, type CustomerCancelSubscriptionResponse, type CustomerExtendSubscriptionApplicationErrors, type CustomerExtendSubscriptionOptions, type CustomerExtendSubscriptionRequest, type CustomerExtendSubscriptionResponse, type CustomerIdOneOf, type CustomerInitiatePaymentMethodSetupOptions, type CustomerListUpcomingChargesRequest, type CustomerListUpcomingChargesResponse, type CustomerQuerySubscriptionsOptions, type CustomerTurnOffAutoRenewalRequest, type CustomerTurnOffAutoRenewalResponse, type CustomerTurnOffSubscriptionAutoRenewalApplicationErrors, type CustomerTurnOffSubscriptionAutoRenewalOptions, type CustomerTurnOnAutoRenewalRequest, type CustomerTurnOnAutoRenewalResponse, type CustomerTurnOnSubscriptionAutoRenewalApplicationErrors, type CustomerTurnOnSubscriptionAutoRenewalOptions, type Cycles, type DeleteDraftSubscriptionRequest, type DeleteDraftSubscriptionResponse, type DeleteSubscriptionBORequest, type DeleteSubscriptionBOResponse, type DeleteSubscriptionRequest, type DeleteSubscriptionResponse, type DetachInvoice, type Discount, type DiscountCycles, type DiscountOrigin, type DiscountValueOneOf, type DomainEvent, type DomainEventBodyOneOf, type Duration, DurationUnit, type DurationUnitWithLiterals, type DynamicTax, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, ExtendPolicyType, type ExtendPolicyTypeWithLiterals, type ExtendSubscriptionApplicationErrors, type ExtendSubscriptionOptions, type ExtendSubscriptionOptionsExtendPolicyOneOf, type ExtendSubscriptionRequest, type ExtendSubscriptionRequestExtendPolicyOneOf, type ExtendSubscriptionResponse, type ExternalCollectionDetails, type ExternalPrice, type ExternalPriceConfig, type FinishFreeTrialNowRequest, type FinishFreeTrialNowResponse, type FixSubscriptionInvoicesConsistencyRequest, type FixSubscriptionInvoicesConsistencyResponse, type FixSubscriptionInvoicesRequest, type FixSubscriptionInvoicesRequestModeOneOf, type FixSubscriptionInvoicesResponse, type FixSubscriptionTimeCapsuleTasksRequest, type FixSubscriptionTimeCapsuleTasksResponse, type FixedAmountFee, type FixedPrice, type FixedPriceConfig, type FreeTrailEnded, type FreeTrailStarted, type FreeTrialData, type FullAddressContactDetails, type FullAddressDetails, type FuturePriceUpdatesRequested, type FutureUpdatesRequested, type GetFullSubscriptionDataRequest, type GetFullSubscriptionDataResponse, type GetSubscriptionAndInternalDataRequest, type GetSubscriptionAndInternalDataResponse, type GetSubscriptionInvoicesRequest, type GetSubscriptionInvoicesResponse, type GetSubscriptionRequest, type GetSubscriptionResponse, type GetSubscriptionsStatsRequest, type GetSubscriptionsStatsResponse, type GracePeriodData, type GracePeriodEnded, type GracePeriodStarted, type HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, HistoryActionInitiator, type HistoryActionInitiatorWithLiterals, HistoryViewMode, type HistoryViewModeWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InitiatePaymentMethodSetupOptions, type InitiatePaymentMethodSetupRequest, type InitiatePaymentMethodSetupResponse, type InitiatedPaymentMethodSetup, type InternalSubscriptionData, type Invoice, type InvoiceAction, type InvoiceActionActionTypeOneOf, type InvoiceApplicationFee, type InvoiceApplicationFeeValueOneOf, type InvoiceDiscount, type InvoiceDiscountValueOneOf, type InvoiceItem, type InvoiceItemPaymentTypeOneOf, type InvoiceItemPricingModelOneOf, type InvoicePlatformFee, type InvoicePlatformFeeFeeModelOneOf, type InvoiceShippingCharges, InvoiceStatus, type InvoiceStatusWithLiterals, type Item, ItemCategory, type ItemCategoryWithLiterals, type ItemChange, type ItemTaxData, type LatestInvoiceMarkedAsPaid, type LatestPaymentAttempt, type LineItemTaxSummary, type ListSubscriptionHistoryOptions, type ListSubscriptionHistoryRequest, type ListSubscriptionHistoryResponse, type ListUpcomingChargesOptions, type ListUpcomingChargesRequest, type ListUpcomingChargesResponse, type MarkBillingCycleAsPaidApplicationErrors, type MarkBillingCycleAsPaidOptions, type MarkBillingCycleAsPaidRequest, type MarkBillingCycleAsPaidResponse, type MarkLatestInvoiceAsPaidApplicationErrors, type MarkLatestInvoiceAsPaidRequest, type MarkLatestInvoiceAsPaidResponse, type MessageEnvelope, type MigrationDetails, type Money, type MultipleSubscriptionsOnOrdersInvoice, type OneTime, OrderMethod, type OrderMethodWithLiterals, type Origin, type OriginOverride, type Paging, type PagingMetadataV2, type PassOnFeeConfig, type PassOnFeeConfigValueOneOf, type PatchSubscriptionRequest, type PatchSubscriptionResponse, PauseAt, type PauseAtWithLiterals, type PauseInfo, type PausePeriod, PausePolicy, type PausePolicyWithLiterals, type PauseSubscriptionApplicationErrors, type PauseSubscriptionBORequest, type PauseSubscriptionBOResponse, type PauseSubscriptionOptions, type PauseSubscriptionRequest, type PauseSubscriptionRequested, type PauseSubscriptionResponse, type PayCycleOptions, type PayCycleRequest, type PayCycleResponse, type PayRecurringInvoice, PaymentAttemptStatus, type PaymentAttemptStatusWithLiterals, type PaymentData, type PaymentMethod, type PaymentMethodUpdated, PaymentMode, type PaymentModeWithLiterals, type PaymentOrigin, type PaymentSettings, PaymentSettlementMethod, type PaymentSettlementMethodWithLiterals, PaymentStatus, PaymentStatusEnumPaymentStatus, type PaymentStatusEnumPaymentStatusWithLiterals, type PaymentStatusWithLiterals, type PaymentTaxData, PaymentTestMode, type PaymentTestModeWithLiterals, type PercentageFee, type PlatformOrigin, type PreviewSubscriptionChargesOptions, type PreviewSubscriptionChargesOptionsSubscriptionOneOf, type PreviewSubscriptionChargesRequest, type PreviewSubscriptionChargesRequestSubscriptionOneOf, type PreviewSubscriptionChargesResponse, type PreviewSubscriptionsChargesOptions, type PreviewSubscriptionsChargesRequest, type PreviewSubscriptionsChargesResponse, type PriceAdjustment, type PriceAdjustmentAdjustmentTypeOneOf, type PriceAdjustmentValue, type PriceAdjustmentValueAdjustmentValueTypeOneOf, type PriceDetails, type PricingModel, type PricingModelModelOneOf, type Proration, type ProrationTypeOneOf, type QuerySubscriptionsRequest, type QuerySubscriptionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type Recurring, type RedirectUrls, type Refund, type RefundInfo, RefundReason, type RefundReasonWithLiterals, type RemoveCancellationInfoRequest, type RemoveCancellationInfoResponse, RequestedFields, type RequestedFieldsWithLiterals, type Reschedule, type ResetPendingUpdates, type RestoreDraftSubscriptionRequest, type RestoreDraftSubscriptionResponse, type RestoreInfo, ResumeAt, type ResumeAtWithLiterals, type ResumeSubscriptionApplicationErrors, type ResumeSubscriptionOptions, type ResumeSubscriptionRequest, type ResumeSubscriptionRequested, type ResumeSubscriptionResponse, type ReviseSubscriptionOptions, type ReviseSubscriptionRequest, type ReviseSubscriptionResponse, RevivePolicy, type RevivePolicyWithLiterals, type ReviveSubscriptionRequest, type ReviveSubscriptionResponse, type RunTimeCapsuleTaskNowRequest, type ScheduleAdditionalInfo, type ScheduleAdditionalInfoParamOneOf, type ScheduleTimeCapsuleTaskRequest, type ScheduledPauseCanceled, type ScheduledResumeCanceled, type SearchSubscriptionRequest, type SearchSubscriptionResponse, type SearchSubscriptionsOptions, type SearchSubscriptionsOptionsPagingMethodOneOf, type SearchSubscriptionsRequest, type SearchSubscriptionsRequestPagingMethodOneOf, type SearchSubscriptionsResponse, type SendSubscriptionActionEventBORequest, type SendSubscriptionActionEventBORequestEventOneOf, type SendSubscriptionActionEventResponse, type SendTimeCapsuleTaskCanceledBIRequest, type SetIsMigratedEvent, type SetShiftingDataRequest, type SetShiftingDataResponse, type ShippingCharges, SortOrder, type SortOrderWithLiterals, type Sorting, type SortingClauses, type SpecificDateSubscriptionUpdateData, Status, type StatusWithLiterals, type StreetAddress, type Subscriber, type Subscription, type SubscriptionActivated, type SubscriptionAutoRenewalTurnedOff, type SubscriptionAutoRenewalTurnedOffEnvelope, type SubscriptionAutoRenewalTurnedOn, type SubscriptionAutoRenewalTurnedOnEnvelope, type SubscriptionBackOfficeAction, type SubscriptionBillingCyclePaid, type SubscriptionBillingCycleStarted, type SubscriptionBillingDateUpdated, type SubscriptionBillingDateUpdatedEnvelope, type SubscriptionBillingDetails, type SubscriptionCanceled, type SubscriptionCanceledEnvelope, type SubscriptionCancellationRequested, type SubscriptionCharge, type SubscriptionCharges, type SubscriptionCollectionMethodUpdated, type SubscriptionCreated, type SubscriptionCycleReadyToPay, type SubscriptionCycleTriggered, type SubscriptionDelayedSyncEvent, type SubscriptionDeleted, type SubscriptionDiff, type SubscriptionEnded, type SubscriptionEvent, type SubscriptionEventPayloadOneOf, type SubscriptionExpired, type SubscriptionExtended, type SubscriptionExtendedEnvelope, type SubscriptionExtendedExtendPolicyOneOf, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionHistoryEntry, type SubscriptionInfo, type SubscriptionInitialPurchaseCompleted, type SubscriptionInvoice, type SubscriptionLatestInvoiceMarkedAsPaidEnvelope, type SubscriptionMarkedAsPaid, type SubscriptionPauseScheduleCanceledEnvelope, type SubscriptionPauseScheduledEnvelope, type SubscriptionPaused, type SubscriptionPausedEnvelope, type SubscriptionPolicies, type SubscriptionPolicy, type SubscriptionResumeScheduleCanceledEnvelope, type SubscriptionResumeScheduledEnvelope, type SubscriptionResumed, type SubscriptionResumedEnvelope, type SubscriptionRevived, type SubscriptionStatus, SubscriptionStatusEnumSubscriptionStatus, type SubscriptionStatusEnumSubscriptionStatusWithLiterals, SubscriptionStatusGroup, type SubscriptionStatusGroupWithLiterals, type SubscriptionSuspended, type SubscriptionTrialPeriod, SubscriptionType, type SubscriptionTypeWithLiterals, type SubscriptionUpdateData, type SubscriptionUpdated, type SubscriptionUpdatedEnvelope, type Suspension, type Task, type TaskAction, type TaskActionActionOneOf, type TaskKey, type Tax, type TaxBreakdown, type TaxData, type TaxSettings, type TaxSummary, type TaxValueOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TimeBasedProration, type Totals, type TurnOffSubscriptionAutoRenewalApplicationErrors, type TurnOffSubscriptionAutoRenewalRequest, type TurnOffSubscriptionAutoRenewalResponse, type TurnOnSubscriptionAutoRenewalApplicationErrors, type TurnOnSubscriptionAutoRenewalRequest, type TurnOnSubscriptionAutoRenewalResponse, type UnknownSubscriptionEvent, type UnsupportedAction, type UnsupportedReason, UpdateAction, type UpdateActionWithLiterals, type UpdateBillingDateData, type UpdateFullSubscriptionRequest, type UpdateFullSubscriptionResponse, type UpdatePausePaidDurationRequest, type UpdatePausePaidDurationResponse, type UpdatePaymentMethodBORequest, type UpdatePaymentMethodBOResponse, type UpdatePaymentStatusRequest, type UpdatePaymentStatusResponse, type UpdateStatusRequest, type UpdateStatusResponse, type UpdateSubscriptionBillingDateApplicationErrors, type UpdateSubscriptionBillingDateOptions, type UpdateSubscriptionBillingDateRequest, type UpdateSubscriptionBillingDateResponse, type UpdateSubscriptionCurrencyRequest, type UpdateSubscriptionCurrencyResponse, type UpdateSubscriptionInvoiceCycleRequest, type UpdateSubscriptionInvoiceCycleResponse, type UpdateSubscriptionItemsRequest, type UpdateSubscriptionItemsResponse, type UpdateSubscriptionOriginRequest, type UpdateSubscriptionOriginResponse, type UpdateSubscriptionPaymentMethodRequest, type UpdateSubscriptionPaymentMethodResponse, type UpdateSubscriptionPlatformOriginRequest, type UpdateSubscriptionPlatformOriginResponse, type UpdateSubscriptionPoliciesRequest, type UpdateSubscriptionPoliciesResponse, type UpdateSubscriptionRequest, type UpdateSubscriptionResponse, type UpdateSubscriptionStartDateRequest, type UpdateSubscriptionStartDateResponse, type UpdatesApplied, type V1Duration, type V1Subscription, type V1SubscriptionActivated, type V1SubscriptionCanceled, type V1SubscriptionCreated, type V1SubscriptionEvent, type V1SubscriptionEventEventOneOf, type V1SubscriptionInitialPurchaseCompleted, type V1SubscriptionResumed, V1SubscriptionStatusEnumSubscriptionStatus, type V1SubscriptionStatusEnumSubscriptionStatusWithLiterals, type V1SubscriptionUpdated, type V2Subscription, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, allowedActions, cancelSubscription, countSubscriptions, customerAllowedActions, customerCancelSubscription, customerExtendSubscription, customerGetSubscription, customerInitiatePaymentMethodSetup, customerListUpcomingCharges, customerQuerySubscriptions, customerTurnOffSubscriptionAutoRenewal, customerTurnOnSubscriptionAutoRenewal, customerUpdateSubscriptionPaymentMethod, extendSubscription, getSubscription, getSubscriptionsStats, initiatePaymentMethodSetup, listSubscriptionHistory, listUpcomingCharges, markLatestInvoiceAsPaid, onSubscriptionAutoRenewalTurnedOff, onSubscriptionAutoRenewalTurnedOn, onSubscriptionBillingDateUpdated, onSubscriptionCanceled, onSubscriptionExtended, onSubscriptionLatestInvoiceMarkedAsPaid, onSubscriptionPauseScheduleCanceled, onSubscriptionPauseScheduled, onSubscriptionPaused, onSubscriptionResumeScheduleCanceled, onSubscriptionResumeScheduled, onSubscriptionResumed, onSubscriptionUpdated, pauseSubscription, payCycle, previewSubscriptionCharges, previewSubscriptionsCharges, querySubscriptions, resumeSubscription, searchSubscriptions, turnOffSubscriptionAutoRenewal, turnOnSubscriptionAutoRenewal, updateSubscriptionBillingDate, updateSubscriptionPaymentMethod };
5584
+ export { type AbsorbFeeConfig, type AbsorbFeeConfigValueOneOf, type AccountInfo, type AccountInfoMetadata, type Action, type ActionContext, type ActionDetails, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, ActionType, type ActionTypeWithLiterals, type AddPausePeriodRequest, type AddPausePeriodResponse, type AdditionalFee, AdditionalFeeTrigger, type AdditionalFeeTriggerWithLiterals, type Address, type AddressStreetOneOf, type AggregatedTaxBreakdown, type AllowedActionsOptions, type AllowedActionsRequest, type AllowedActionsResponse, type AmountByStatus, type ApplicationFee, type ApplicationFeeValueOneOf, type AttachInvoice, type AutomaticRetryData, type BaseEventMetadata, type BassToSapiPaypalMigrationRequest, type BassToSapiPaypalMigrationResponse, type BillingSettings, type BillingStatus, type BulkItemChange, type BulkUpdateSubscriptionItemsByFilterRequest, type BulkUpdateSubscriptionItemsByFilterResponse, type BusinessOrigin, type BusinessOriginData, type Cancel, type CancelActionConfiguration, type CancelActionSettings, type CancelPendingChangeRequest, type CancelPendingChangeResponse, type CancelSubscriptionApplicationErrors, type CancelSubscriptionBORequest, type CancelSubscriptionBOResponse, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CancelTimeCapsuleTaskRequest, type CancellationInfo, CancellationInitiator, type CancellationInitiatorWithLiterals, type CatalogReference, ChangeEffectiveTime, type ChangeEffectiveTimeWithLiterals, type ChangePaymentContext, type ChangeSubscriptionRequest, type ChangeSubscriptionResponse, type Charge, CollectionMethod, CollectionMethodEnumCollectionMethod, type CollectionMethodEnumCollectionMethodWithLiterals, type CollectionMethodWithLiterals, type Complete, type ConvertSapiRequest, type ConvertSapiResponse, type CountByStatus, type CountSubscriptionFilter, type CountSubscriptionFilterStatusOneOf, type CountSubscriptionsOptions, type CountSubscriptionsRequest, type CountSubscriptionsResponse, type CreateRecurringInvoiceBORequest, type CreateRecurringInvoiceBOResponse, type CreateSubscriptionForOrderRequest, type CreateSubscriptionForOrderResponse, type CreateSubscriptionInStateRequest, type CreateSubscriptionInStateRequestModeOneOf, type CreateSubscriptionInStateResponse, type CreateSubscriptionRequest, type CreateSubscriptionResponse, CreationMode, type CreationModeWithLiterals, type CursorPaging, type CursorPagingMetadata, type Cursors, type CustomBillingSchedule, type CustomProration, type CustomProrationAmountOneOf, type Customer, type CustomerAction, type CustomerActionConfigurationOneOf, type CustomerActionSettings, type CustomerAllowedActionsRequest, type CustomerAllowedActionsResponse, type CustomerCancelConfiguration, type CustomerCancelScheduledPauseApplicationErrors, type CustomerCancelScheduledPauseOptions, type CustomerCancelScheduledPauseRequest, type CustomerCancelScheduledPauseResponse, type CustomerCancelScheduledSkipApplicationErrors, type CustomerCancelScheduledSkipOptions, type CustomerCancelScheduledSkipRequest, type CustomerCancelScheduledSkipResponse, type CustomerCancelSubscriptionApplicationErrors, type CustomerCancelSubscriptionOptions, type CustomerCancelSubscriptionRequest, type CustomerCancelSubscriptionResponse, type CustomerExtendSubscriptionApplicationErrors, type CustomerExtendSubscriptionOptions, type CustomerExtendSubscriptionRequest, type CustomerExtendSubscriptionResponse, type CustomerIdOneOf, type CustomerInitiatePaymentMethodSetupOptions, type CustomerListUpcomingChargesRequest, type CustomerListUpcomingChargesResponse, type CustomerPauseResumeConfiguration, type CustomerPauseSubscriptionApplicationErrors, type CustomerPauseSubscriptionOptions, type CustomerPauseSubscriptionRequest, type CustomerPauseSubscriptionResponse, type CustomerQuerySubscriptionsOptions, type CustomerResumeSubscriptionApplicationErrors, type CustomerResumeSubscriptionOptions, type CustomerResumeSubscriptionRequest, type CustomerResumeSubscriptionResponse, type CustomerSkipConfiguration, type CustomerSkipCycleApplicationErrors, type CustomerSkipCycleOptions, type CustomerSkipCycleRequest, type CustomerSkipCycleResponse, type CustomerTurnOffAutoRenewalRequest, type CustomerTurnOffAutoRenewalResponse, type CustomerTurnOffSubscriptionAutoRenewalApplicationErrors, type CustomerTurnOffSubscriptionAutoRenewalOptions, type CustomerTurnOnAutoRenewalRequest, type CustomerTurnOnAutoRenewalResponse, type CustomerTurnOnSubscriptionAutoRenewalApplicationErrors, type CustomerTurnOnSubscriptionAutoRenewalOptions, type CustomerUpdateBillingDateApplicationErrors, type CustomerUpdateBillingDateConfiguration, type CustomerUpdateBillingDateOptions, type CustomerUpdateBillingDateRequest, type CustomerUpdateBillingDateResponse, type Cycles, type DeleteDraftSubscriptionRequest, type DeleteDraftSubscriptionResponse, type DeleteSubscriptionBORequest, type DeleteSubscriptionBOResponse, type DeleteSubscriptionRequest, type DeleteSubscriptionResponse, type DetachInvoice, type Discount, type DiscountCycles, type DiscountOrigin, type DiscountValueOneOf, type DomainEvent, type DomainEventBodyOneOf, type Duration, DurationUnit, type DurationUnitWithLiterals, type DynamicTax, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, ExtendPolicyType, type ExtendPolicyTypeWithLiterals, type ExtendSubscriptionApplicationErrors, type ExtendSubscriptionOptions, type ExtendSubscriptionOptionsExtendPolicyOneOf, type ExtendSubscriptionRequest, type ExtendSubscriptionRequestExtendPolicyOneOf, type ExtendSubscriptionResponse, type ExternalCollectionDetails, type ExternalPrice, type ExternalPriceConfig, type FinishFreeTrialNowRequest, type FinishFreeTrialNowResponse, type FixSubscriptionInvoicesConsistencyRequest, type FixSubscriptionInvoicesConsistencyResponse, type FixSubscriptionInvoicesRequest, type FixSubscriptionInvoicesRequestModeOneOf, type FixSubscriptionInvoicesResponse, type FixSubscriptionTimeCapsuleTasksRequest, type FixSubscriptionTimeCapsuleTasksResponse, type FixedAmountFee, type FixedPrice, type FixedPriceConfig, type FreeTrailEnded, type FreeTrailStarted, type FreeTrialData, type FullAddressContactDetails, type FullAddressDetails, type FuturePriceUpdatesRequested, type FutureUpdatesRequested, type GetFullSubscriptionDataRequest, type GetFullSubscriptionDataResponse, type GetSubscriptionAndInternalDataRequest, type GetSubscriptionAndInternalDataResponse, type GetSubscriptionInvoicesRequest, type GetSubscriptionInvoicesResponse, type GetSubscriptionRequest, type GetSubscriptionResponse, type GetSubscriptionsStatsRequest, type GetSubscriptionsStatsResponse, type GracePeriodData, type GracePeriodEnded, type GracePeriodStarted, type HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, HistoryActionInitiator, type HistoryActionInitiatorWithLiterals, HistoryViewMode, type HistoryViewModeWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InitiatePaymentMethodSetupOptions, type InitiatePaymentMethodSetupRequest, type InitiatePaymentMethodSetupResponse, type InitiatedPaymentMethodSetup, type InternalSubscriptionData, type Invoice, type InvoiceAction, type InvoiceActionActionTypeOneOf, type InvoiceApplicationFee, type InvoiceApplicationFeeValueOneOf, type InvoiceDiscount, type InvoiceDiscountValueOneOf, type InvoiceItem, type InvoiceItemPaymentTypeOneOf, type InvoiceItemPricingModelOneOf, type InvoicePlatformFee, type InvoicePlatformFeeFeeModelOneOf, type InvoiceShippingCharges, InvoiceStatus, type InvoiceStatusWithLiterals, type Item, ItemCategory, type ItemCategoryWithLiterals, type ItemChange, type ItemTaxData, type LatestInvoiceMarkedAsPaid, type LatestPaymentAttempt, type LineItemTaxSummary, type ListSubscriptionHistoryOptions, type ListSubscriptionHistoryRequest, type ListSubscriptionHistoryResponse, type ListUpcomingChargesOptions, type ListUpcomingChargesRequest, type ListUpcomingChargesResponse, type MarkBillingCycleAsPaidApplicationErrors, type MarkBillingCycleAsPaidOptions, type MarkBillingCycleAsPaidRequest, type MarkBillingCycleAsPaidResponse, type MarkLatestInvoiceAsPaidApplicationErrors, type MarkLatestInvoiceAsPaidRequest, type MarkLatestInvoiceAsPaidResponse, type MessageEnvelope, type MigrationDetails, type Money, type MultipleSubscriptionsOnOrdersInvoice, type OneTime, OrderMethod, type OrderMethodWithLiterals, type Origin, type OriginOverride, type Paging, type PagingMetadataV2, type PassOnFeeConfig, type PassOnFeeConfigValueOneOf, type PatchSubscriptionRequest, type PatchSubscriptionResponse, PauseAt, type PauseAtWithLiterals, type PauseInfo, type PausePeriod, PausePolicy, type PausePolicyWithLiterals, type PauseResumeActionConfiguration, type PauseResumeActionSettings, type PauseSubscriptionApplicationErrors, type PauseSubscriptionBORequest, type PauseSubscriptionBOResponse, type PauseSubscriptionOptions, type PauseSubscriptionRequest, type PauseSubscriptionRequested, type PauseSubscriptionResponse, type PayCycleOptions, type PayCycleRequest, type PayCycleResponse, type PayRecurringInvoice, PaymentAttemptStatus, type PaymentAttemptStatusWithLiterals, type PaymentData, type PaymentMethod, type PaymentMethodUpdated, PaymentMode, type PaymentModeWithLiterals, type PaymentOrigin, type PaymentSettings, PaymentSettlementMethod, type PaymentSettlementMethodWithLiterals, PaymentStatus, PaymentStatusEnumPaymentStatus, type PaymentStatusEnumPaymentStatusWithLiterals, type PaymentStatusWithLiterals, type PaymentTaxData, PaymentTestMode, type PaymentTestModeWithLiterals, type PercentageFee, type PlatformOrigin, type PreviewChangeSubscriptionRequest, type PreviewChangeSubscriptionResponse, type PreviewSubscriptionChargesOptions, type PreviewSubscriptionChargesOptionsSubscriptionOneOf, type PreviewSubscriptionChargesRequest, type PreviewSubscriptionChargesRequestSubscriptionOneOf, type PreviewSubscriptionChargesResponse, type PreviewSubscriptionsChargesOptions, type PreviewSubscriptionsChargesRequest, type PreviewSubscriptionsChargesResponse, type PriceAdjustment, type PriceAdjustmentAdjustmentTypeOneOf, PriceAdjustmentReason, type PriceAdjustmentReasonWithLiterals, type PriceAdjustmentValue, type PriceAdjustmentValueAdjustmentValueTypeOneOf, type PriceDetails, type PricingModel, type PricingModelModelOneOf, type Proration, ProrationAction, type ProrationActionWithLiterals, ProrationBehavior, type ProrationBehaviorWithLiterals, type ProrationPreview, type ProrationResult, type ProrationTypeOneOf, type QuerySubscriptionsRequest, type QuerySubscriptionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type Recurring, type RedirectUrls, type Refund, type RefundInfo, RefundReason, type RefundReasonWithLiterals, type RemoveCancellationInfoRequest, type RemoveCancellationInfoResponse, type RenewalPreview, RequestedFields, type RequestedFieldsWithLiterals, type Reschedule, type ResetPendingUpdates, type RestoreDraftSubscriptionRequest, type RestoreDraftSubscriptionResponse, type RestoreInfo, ResumeAt, type ResumeAtWithLiterals, type ResumeSubscriptionApplicationErrors, type ResumeSubscriptionOptions, type ResumeSubscriptionRequest, type ResumeSubscriptionRequested, type ResumeSubscriptionResponse, type ReviseSubscriptionOptions, type ReviseSubscriptionRequest, type ReviseSubscriptionResponse, RevivePolicy, type RevivePolicyWithLiterals, type ReviveSubscriptionRequest, type ReviveSubscriptionResponse, type RunTimeCapsuleTaskNowRequest, type ScheduleAdditionalInfo, type ScheduleAdditionalInfoParamOneOf, type ScheduleTimeCapsuleTaskRequest, type ScheduledPauseCanceled, type ScheduledResumeCanceled, type SearchSubscriptionRequest, type SearchSubscriptionResponse, type SearchSubscriptionsOptions, type SearchSubscriptionsOptionsPagingMethodOneOf, type SearchSubscriptionsRequest, type SearchSubscriptionsRequestPagingMethodOneOf, type SearchSubscriptionsResponse, type SendSubscriptionActionEventBORequest, type SendSubscriptionActionEventBORequestEventOneOf, type SendSubscriptionActionEventResponse, type SendTimeCapsuleTaskCanceledBIRequest, type SetIsMigratedEvent, type SetShiftingDataRequest, type SetShiftingDataResponse, type ShippingCharges, type SkipActionConfiguration, type SkipActionSettings, SortOrder, type SortOrderWithLiterals, type Sorting, type SortingClauses, type SpecificDateSubscriptionUpdateData, Status, type StatusWithLiterals, type StreetAddress, type Subscriber, type Subscription, type SubscriptionActivated, type SubscriptionAutoRenewalTurnedOff, type SubscriptionAutoRenewalTurnedOffEnvelope, type SubscriptionAutoRenewalTurnedOn, type SubscriptionAutoRenewalTurnedOnEnvelope, type SubscriptionBackOfficeAction, type SubscriptionBillingCyclePaid, type SubscriptionBillingCycleStarted, type SubscriptionBillingDateUpdated, type SubscriptionBillingDateUpdatedEnvelope, type SubscriptionBillingDetails, type SubscriptionCanceled, type SubscriptionCanceledEnvelope, type SubscriptionCancellationRequested, type SubscriptionChangeSummary, type SubscriptionCharge, type SubscriptionCharges, type SubscriptionCollectionMethodUpdated, type SubscriptionCreated, type SubscriptionCycleReadyToPay, type SubscriptionCycleTriggered, type SubscriptionDelayedSyncEvent, type SubscriptionDeleted, type SubscriptionDiff, type SubscriptionEnded, type SubscriptionEvent, type SubscriptionEventPayloadOneOf, type SubscriptionExpired, type SubscriptionExtended, type SubscriptionExtendedEnvelope, type SubscriptionExtendedExtendPolicyOneOf, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionHistoryEntry, type SubscriptionInfo, type SubscriptionInitialPurchaseCompleted, type SubscriptionInvoice, type SubscriptionLatestInvoiceMarkedAsPaidEnvelope, type SubscriptionMarkedAsPaid, type SubscriptionPauseScheduleCanceledEnvelope, type SubscriptionPauseScheduledEnvelope, type SubscriptionPaused, type SubscriptionPausedEnvelope, type SubscriptionPolicies, type SubscriptionPolicy, type SubscriptionResumeScheduleCanceledEnvelope, type SubscriptionResumeScheduledEnvelope, type SubscriptionResumed, type SubscriptionResumedEnvelope, type SubscriptionRevived, type SubscriptionStatus, SubscriptionStatusEnumSubscriptionStatus, type SubscriptionStatusEnumSubscriptionStatusWithLiterals, SubscriptionStatusGroup, type SubscriptionStatusGroupWithLiterals, type SubscriptionSuspended, type SubscriptionTrialPeriod, SubscriptionType, type SubscriptionTypeWithLiterals, type SubscriptionUpdateData, type SubscriptionUpdated, type SubscriptionUpdatedEnvelope, type Suspension, type Task, type TaskAction, type TaskActionActionOneOf, type TaskKey, type Tax, type TaxBreakdown, type TaxData, type TaxSettings, type TaxSummary, type TaxValueOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TimeBasedProration, type Totals, type TurnOffSubscriptionAutoRenewalApplicationErrors, type TurnOffSubscriptionAutoRenewalRequest, type TurnOffSubscriptionAutoRenewalResponse, type TurnOnSubscriptionAutoRenewalApplicationErrors, type TurnOnSubscriptionAutoRenewalRequest, type TurnOnSubscriptionAutoRenewalResponse, type UnknownSubscriptionEvent, type UnsupportedAction, type UnsupportedReason, UpdateAction, type UpdateActionWithLiterals, type UpdateBillingDateActionConfiguration, type UpdateBillingDateActionSettings, type UpdateBillingDateData, type UpdateFullSubscriptionRequest, type UpdateFullSubscriptionResponse, type UpdatePausePaidDurationRequest, type UpdatePausePaidDurationResponse, type UpdatePaymentMethodBORequest, type UpdatePaymentMethodBOResponse, type UpdatePaymentStatusRequest, type UpdatePaymentStatusResponse, type UpdateStatusRequest, type UpdateStatusResponse, type UpdateSubscriptionBillingDateApplicationErrors, type UpdateSubscriptionBillingDateOptions, type UpdateSubscriptionBillingDateRequest, type UpdateSubscriptionBillingDateResponse, type UpdateSubscriptionCurrencyRequest, type UpdateSubscriptionCurrencyResponse, type UpdateSubscriptionInvoiceCycleRequest, type UpdateSubscriptionInvoiceCycleResponse, type UpdateSubscriptionItemsRequest, type UpdateSubscriptionItemsResponse, type UpdateSubscriptionOriginRequest, type UpdateSubscriptionOriginResponse, type UpdateSubscriptionPaymentMethodRequest, type UpdateSubscriptionPaymentMethodResponse, type UpdateSubscriptionPlatformOriginRequest, type UpdateSubscriptionPlatformOriginResponse, type UpdateSubscriptionPoliciesRequest, type UpdateSubscriptionPoliciesResponse, type UpdateSubscriptionRequest, type UpdateSubscriptionResponse, type UpdateSubscriptionStartDateRequest, type UpdateSubscriptionStartDateResponse, type UpdatesApplied, type UpmActionSettings, type V1Duration, type V1Subscription, type V1SubscriptionActivated, type V1SubscriptionCanceled, type V1SubscriptionCreated, type V1SubscriptionEvent, type V1SubscriptionEventEventOneOf, type V1SubscriptionInitialPurchaseCompleted, type V1SubscriptionResumed, V1SubscriptionStatusEnumSubscriptionStatus, type V1SubscriptionStatusEnumSubscriptionStatusWithLiterals, type V1SubscriptionUpdated, type V2Subscription, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, allowedActions, cancelSubscription, countSubscriptions, customerAllowedActions, customerCancelSubscription, customerExtendSubscription, customerGetSubscription, customerInitiatePaymentMethodSetup, customerListUpcomingCharges, customerQuerySubscriptions, customerTurnOffSubscriptionAutoRenewal, customerTurnOnSubscriptionAutoRenewal, customerUpdateSubscriptionPaymentMethod, extendSubscription, getSubscription, getSubscriptionsStats, initiatePaymentMethodSetup, listSubscriptionHistory, listUpcomingCharges, markLatestInvoiceAsPaid, onSubscriptionAutoRenewalTurnedOff, onSubscriptionAutoRenewalTurnedOn, onSubscriptionBillingDateUpdated, onSubscriptionCanceled, onSubscriptionExtended, onSubscriptionLatestInvoiceMarkedAsPaid, onSubscriptionPauseScheduleCanceled, onSubscriptionPauseScheduled, onSubscriptionPaused, onSubscriptionResumeScheduleCanceled, onSubscriptionResumeScheduled, onSubscriptionResumed, onSubscriptionUpdated, pauseSubscription, payCycle, previewSubscriptionCharges, previewSubscriptionsCharges, querySubscriptions, resumeSubscription, searchSubscriptions, turnOffSubscriptionAutoRenewal, turnOnSubscriptionAutoRenewal, updateSubscriptionBillingDate, updateSubscriptionPaymentMethod };