@wix/auto_sdk_subscription_subscriptions 1.0.0 → 1.0.2

package/build/internal/es/src/billing-v1-subscription-subscriptions.types.d.ts

@@ -1,6 +1,7 @@
 export interface Subscription {
     /**
      * Subscription's unique id. Automatically generated and read-only.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -19,9 +20,15 @@ export interface Subscription {
      * @readonly
      */
     revision?: string | null;
-    /** Subscription name: minLength is 1, maxLength is 150 */
+    /**
+     * Subscription name: minLength is 1, maxLength is 150
+     * @maxLength 150
+     */
     name?: string;
-    /** Subscription description. Optional. */
+    /**
+     * Subscription description. Optional.
+     * @maxLength 500
+     */
     description?: string | null;
     /**
      * 3. No Start Date:
@@ -74,6 +81,7 @@ export interface Subscription {
      * Key / Value store to keep up to 10 additional values related to the subscription.
      * Key max length = 50, Value max length = 200. Value can not be empty.
      * Should not include any sensitive or PII information.
+     * @maxSize 10
      */
     metadata?: Record<string, string>;
     /**
@@ -86,36 +94,53 @@ export interface Subscription {
      * @readonly
      */
     changesCounter?: string | null;
-    /** Billing order id. Optional. */
+    /**
+     * Billing order id. Optional.
+     * @format GUID
+     */
     orderId?: string | null;
     /** Platform origin subscription is coming from. */
     platformOrigin?: PlatformOrigin;
-    /** The Business Location ID represents a business location in an external service, which includes the business address. */
+    /**
+     * The Business Location ID represents a business location in an external service, which includes the business address.
+     * @format GUID
+     */
     businessLocationId?: string | null;
-    /** items, minSize is 1, maxSize is 100 */
+    /**
+     * items, minSize is 1, maxSize is 100
+     * @maxSize 100
+     */
     items?: Item[];
 }
 export interface BusinessOrigin {
+    /** @format GUID */
     appId?: string | null;
+    /** @format GUID */
     entityId?: string | null;
 }
 export interface Customer extends CustomerIdOneOf {
     /**
      * Visitor ID of the customer. Available when the customer is an anonymous
      * site visitor.
+     * @format GUID
      */
     visitorId?: string;
     /**
      * Contact ID of the customer. Available when the customer is a
      * [contact](https://dev.wix.com/docs/rest/api-reference/people-communications/contacts/contacts/contact-v-4#contact-object).
+     * @format GUID
      */
     contactId?: string;
     /**
      * Member ID of the customer. Available when the customer is a
      * [member](https://dev.wix.com/docs/rest/api-reference/people-communications/members/members#member-object).
+     * @format GUID
      */
     memberId?: string;
-    /** Wix account ID */
+    /**
+     * Wix account ID
+     * @format GUID
+     */
     accountId?: string;
 }
 /** @oneof */
@@ -123,19 +148,25 @@ export interface CustomerIdOneOf {
     /**
      * Visitor ID of the customer. Available when the customer is an anonymous
      * site visitor.
+     * @format GUID
      */
     visitorId?: string;
     /**
      * Contact ID of the customer. Available when the customer is a
      * [contact](https://dev.wix.com/docs/rest/api-reference/people-communications/contacts/contacts/contact-v-4#contact-object).
+     * @format GUID
      */
     contactId?: string;
     /**
      * Member ID of the customer. Available when the customer is a
      * [member](https://dev.wix.com/docs/rest/api-reference/people-communications/members/members#member-object).
+     * @format GUID
      */
     memberId?: string;
-    /** Wix account ID */
+    /**
+     * Wix account ID
+     * @format GUID
+     */
     accountId?: string;
 }
 export declare enum SubscriptionStatusEnumSubscriptionStatus {
@@ -154,7 +185,10 @@ export declare enum SubscriptionStatusEnumSubscriptionStatus {
     CANCELED = "CANCELED"
 }
 export interface BillingSettings {
-    /** Currency of all subscription items prices. Three letter ISO currency code. https://en.wikipedia.org/wiki/ISO_4217 */
+    /**
+     * Currency of all subscription items prices. Three letter ISO currency code. https://en.wikipedia.org/wiki/ISO_4217
+     * @format CURRENCY
+     */
     currency?: string;
     /** customer payment source to make recurring payments with */
     paymentMethod?: PaymentMethod;
@@ -165,7 +199,10 @@ export interface BillingSettings {
      * Shortest supported cycle duration is 7 days.
      */
     cycleDuration?: Duration;
-    /** Number of billing cycles. If not set subscription auto-renewed until cycle-auto-renew will be disabled. */
+    /**
+     * Number of billing cycles. If not set subscription auto-renewed until cycle-auto-renew will be disabled.
+     * @min 1
+     */
     totalCycles?: number | null;
     /** If set to false, subscription will be canceled at the next billing cycle. */
     cycleAutoRenew?: boolean;
@@ -175,6 +212,7 @@ export interface BillingSettings {
     freeTrialDuration?: Duration;
     /**
      * Shipping costs collected each cycle
+     * @format DECIMAL_VALUE
      * @deprecated
      * @replacedBy shipping_charges
      * @targetRemovalDate 2024-10-31
@@ -189,11 +227,15 @@ export interface BillingSettings {
      * subscription.
      *
      * Max: 5 additional fees
+     * @maxSize 5
      */
     additionalFees?: AdditionalFee[];
     /** Shipping fee charges */
     shippingCharges?: ShippingCharges;
-    /** General discount that applied to all items in the subscription */
+    /**
+     * General discount that applied to all items in the subscription
+     * @maxSize 5
+     */
     discounts?: Discount[];
     /**
      * Details about the external collection service.
@@ -202,7 +244,10 @@ export interface BillingSettings {
     externalCollectionDetails?: ExternalCollectionDetails;
 }
 export interface PaymentMethod {
-    /** reference to payment source id stored in payments system */
+    /**
+     * reference to payment source id stored in payments system
+     * @format GUID
+     */
     id?: string;
 }
 export declare enum CollectionMethodEnumCollectionMethod {
@@ -221,7 +266,10 @@ export declare enum CollectionMethodEnumCollectionMethod {
 export interface Duration {
     /** Duration unit: DAY, WEEK, MONTH, YEAR */
     unit?: DurationUnit;
-    /** Amount of units. For example,  1 MONTH, 1 YEAR, 2 WEEKS, etc. Optional. Default is 1. */
+    /**
+     * Amount of units. For example,  1 MONTH, 1 YEAR, 2 WEEKS, etc. Optional. Default is 1.
+     * @min 1
+     */
     count?: number | null;
 }
 export declare enum DurationUnit {
@@ -235,6 +283,8 @@ export interface CustomBillingSchedule {
     /**
      * Amount of cycles to be paid on Subscription creation, currently only cycles_to_pay_on_creation equals to 1 is supported
      * When used with Subscription.start_date, Subscription cycles will be paid on creation but Subscription will be activated in the future
+     * @min 1
+     * @max 1
      */
     cyclesToPayOnCreation?: number | null;
 }
@@ -249,11 +299,17 @@ export interface FullAddressContactDetails {
     firstName?: string | null;
     /** Last name of the contact. */
     lastName?: string | null;
-    /** Phone number of the contact. */
+    /**
+     * Phone number of the contact.
+     * @format PHONE
+     */
     phone?: string | null;
     /** Company associated with the contact. */
     company?: string | null;
-    /** Email address of the contact. */
+    /**
+     * Email address of the contact.
+     * @format EMAIL
+     */
     email?: string | null;
 }
 export interface Address extends AddressStreetOneOf {
@@ -265,6 +321,7 @@ export interface Address extends AddressStreetOneOf {
      * 2-letter country code in
      * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
      * format.
+     * @format COUNTRY
      */
     country?: string | null;
     /**
@@ -299,12 +356,14 @@ export interface AdditionalFee {
      * Name of the conditional fee.
      *
      * Max: 500 characters
+     * @maxLength 500
      */
     name?: string;
     /**
      * Amount of the conditional fee.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -352,6 +411,7 @@ export interface Tax extends TaxValueOneOf {
      * amount and not a precentage.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -361,6 +421,7 @@ export interface Tax extends TaxValueOneOf {
      *
      * Min: `0.01`
      * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
      */
     percentage?: string;
     /** Dynamic tax calculation */
@@ -373,6 +434,7 @@ export interface TaxValueOneOf {
      * amount and not a precentage.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -382,13 +444,17 @@ export interface TaxValueOneOf {
      *
      * Min: `0.01`
      * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
      */
     percentage?: string;
     /** Dynamic tax calculation */
     dynamic?: DynamicTax;
 }
 export interface DynamicTax {
-    /** Tax group ID used to calculate tax, default will be used if not available */
+    /**
+     * Tax group ID used to calculate tax, default will be used if not available
+     * @format GUID
+     */
     taxGroupId?: string | null;
     /** Taxable address used to calculate tax */
     taxableAddressType?: TaxableAddressType;
@@ -403,13 +469,21 @@ export declare enum TaxableAddressType {
     SHIPPING = "SHIPPING"
 }
 export interface Cycles {
-    /** The cycle will start. Minimum cycle number is 1 */
+    /**
+     * The cycle will start. Minimum cycle number is 1
+     * @min 1
+     */
     cycleFrom?: number;
-    /** Number of cycles to be applied on. In order to apply a on all cycles until the end of the subscription, this field should be empty. */
+    /**
+     * Number of cycles to be applied on. In order to apply a on all cycles until the end of the subscription, this field should be empty.
+     * @min 1
+     */
     numberOfCycles?: number | null;
 }
 export interface Origin {
+    /** @format GUID */
     appId?: string;
+    /** @format GUID */
     entityId?: string;
 }
 export interface ShippingCharges {
@@ -417,10 +491,12 @@ export interface ShippingCharges {
      * Amount of the shipping fee in `0.00` format.
      *
      * Min: `0.01`
+     * @decimalValue options { gte:0.00, maxScale:2 }
      */
     amount?: string;
     /** Tax of the shipping fee */
     tax?: Tax;
+    /** @maxSize 5 */
     discounts?: Discount[];
 }
 export interface Discount extends DiscountValueOneOf {
@@ -429,6 +505,7 @@ export interface Discount extends DiscountValueOneOf {
      * Available when the discount is an amount.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -437,6 +514,7 @@ export interface Discount extends DiscountValueOneOf {
      *
      * Min: `0.01`
      * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
      */
     percentage?: string;
     cycles?: DiscountCycles;
@@ -450,6 +528,7 @@ export interface DiscountValueOneOf {
      * Available when the discount is an amount.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -458,17 +537,26 @@ export interface DiscountValueOneOf {
      *
      * Min: `0.01`
      * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
      */
     percentage?: string;
 }
 export interface DiscountCycles {
-    /** The cycle from which the discount will start. Minimum cycle number is 1 */
+    /**
+     * The cycle from which the discount will start. Minimum cycle number is 1
+     * @min 1
+     */
     cycleFrom?: number;
-    /** Number of cycles to be applied on them discount. In order to apply a discount on all cycles until the end of the subscription, this field should be empty. */
+    /**
+     * Number of cycles to be applied on them discount. In order to apply a discount on all cycles until the end of the subscription, this field should be empty.
+     * @min 1
+     */
     numberOfCycles?: number | null;
 }
 export interface DiscountOrigin {
+    /** @format GUID */
     appId?: string;
+    /** @format GUID */
     entityId?: string;
 }
 export interface ExternalCollectionDetails {
@@ -500,6 +588,7 @@ export interface BillingStatus {
 }
 /** TODO: fill docs */
 export interface PaymentData {
+    /** @format GUID */
     invoiceId?: string;
     paymentStatus?: PaymentStatus;
     totals?: Totals;
@@ -519,47 +608,56 @@ export interface Totals {
     /**
      * Total price of the subscription that the customer must pay per billing
      * cycle. Calculated as: `subtotal + tax + shippingFee + applicationFee + extraCharge - discount - credit`
+     * @format DECIMAL_VALUE
      * @readonly
      */
     totalPrice?: string;
     /**
      * Subtotal of all line items that belong to the subscription.
      * Calculated as: `sum_{i=1}^{n} (itemPrice[i] * quantity[i])`
+     * @format DECIMAL_VALUE
      * @readonly
      */
     subtotal?: string;
     /**
      * Total tax.
+     * @format DECIMAL_VALUE
      * @readonly
      */
     tax?: string | null;
     /**
      * Total discount.
+     * @format DECIMAL_VALUE
      * @readonly
      */
     discount?: string | null;
     /**
      * Total application fee.
+     * @format DECIMAL_VALUE
      * @readonly
      */
     applicationFee?: string | null;
     /**
      * Total shipping fee.
+     * @format DECIMAL_VALUE
      * @readonly
      */
     shippingFee?: string | null;
     /**
      * Total extra charges without tax.
+     * @format DECIMAL_VALUE
      * @readonly
      */
     extraCharge?: string | null;
     /**
      * Total credits without tax.
+     * @format DECIMAL_VALUE
      * @readonly
      */
     credit?: string | null;
     /**
      * The tax amount for the proration, which is also included in the total tax.
+     * @format DECIMAL_VALUE
      * @readonly
      */
     prorationTax?: string | null;
@@ -624,6 +722,7 @@ export interface CustomProration extends CustomProrationAmountOneOf {
      * Increases the total that the customer must pay with the next invoice.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     charge?: string;
     /**
@@ -631,6 +730,7 @@ export interface CustomProration extends CustomProrationAmountOneOf {
      * Lowers the total that the customer must pay with the next invoice.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     credit?: string;
 }
@@ -641,6 +741,7 @@ export interface CustomProrationAmountOneOf {
      * Increases the total that the customer must pay with the next invoice.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     charge?: string;
     /**
@@ -648,6 +749,7 @@ export interface CustomProrationAmountOneOf {
      * Lowers the total that the customer must pay with the next invoice.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     credit?: string;
 }
@@ -730,16 +832,26 @@ export declare enum HistoryActionInitiator {
     PAYMENT_FAILURE = "PAYMENT_FAILURE"
 }
 export interface SubscriptionUpdateData {
+    /** @maxSize 100 */
     itemsToUpdate?: ItemChange[];
+    /** @maxSize 99 */
     itemsToAdd?: Item[];
+    /**
+     * @format GUID
+     * @maxSize 99
+     */
     itemsToDelete?: string[] | null;
     /** @readonly */
     numberOfRequests?: number;
 }
 export interface ItemChange {
-    /** Item ID */
+    /**
+     * Item ID
+     * @format GUID
+     */
     id?: string;
     pricingModel?: PricingModel;
+    /** @min 1 */
     quantity?: number | null;
     tax?: Tax;
 }
@@ -758,6 +870,7 @@ export interface FixedPrice {
      * Price doesn't include tax, discounts, or application fee.
      *
      * Min: `0.01`
+     * @decimalValue options { gte:0.00 }
      */
     itemPrice?: string;
 }
@@ -765,40 +878,60 @@ export interface Item {
     /**
      * Unique identifier of subscription item. Automatically generated and read-only.
      * @readonly
+     * @format GUID
      */
     id?: string | null;
-    /** Name of the item. Typically product name. */
+    /**
+     * Name of the item. Typically product name.
+     * @minLength 1
+     * @maxLength 200
+     */
     name?: string;
-    /** Description of the item. */
+    /**
+     * Description of the item.
+     * @maxLength 500
+     */
     description?: string | null;
     /** References to external product catalog data known to client. */
     catalogReference?: CatalogReference;
     /** Category of item. Whether it is digital or physical one. */
     category?: ItemCategory;
-    /** Amount of products */
+    /**
+     * Amount of products
+     * @min 1
+     */
     quantity?: number;
     /** Pricing model of the item. Whether fixed price or dynamic price models. */
     pricingModel?: PricingModel;
     /** Tax, positive value, optional */
     tax?: Tax;
-    /** Discounts applied on item price */
+    /**
+     * Discounts applied on item price
+     * @maxSize 5
+     */
     discounts?: Discount[];
     /** Application specific fee, positive value, optional (if application_fee == 0, don't include it to request). Only positive values. */
     applicationFee?: ApplicationFee;
     /**
      * External reference identifier for mapping item in consumer's system.
      * This allows the consumer to correlate the item in their system with the item in this API.
+     * @format GUID
      */
     externalId?: string | null;
     /**
      * Key / Value store to keep up to 10 additional values related to the subscription item.
      * Key max length = 50, Value max length = 200. Value can not be empty.
      * Should not include any sensitive or PII information.
+     * @maxSize 10
      */
     metadata?: Record<string, string>;
 }
 export interface CatalogReference {
-    /** Product ID from the external catalog. */
+    /**
+     * Product ID from the external catalog.
+     * @minLength 1
+     * @maxLength 50
+     */
     catalogItemId?: string;
     /**
      * ID of the app that the product catalog belongs to.
@@ -807,6 +940,8 @@ export interface CatalogReference {
      *
      * Min: 1 character
      * Max: 50 characters
+     * @minLength 1
+     * @maxLength 50
      */
     appId?: string | null;
 }
@@ -816,18 +951,25 @@ export declare enum ItemCategory {
     DIGITAL = "DIGITAL"
 }
 export interface ApplicationFee extends ApplicationFeeValueOneOf {
-    /** Amount of the application fee in `0.00` format. */
+    /**
+     * Amount of the application fee in `0.00` format.
+     * @format DECIMAL_VALUE
+     */
     amount?: string;
     /**
      * Discounts for the application fee.
      *
      * Max: 5 discounts
+     * @maxSize 5
      */
     discounts?: Discount[];
 }
 /** @oneof */
 export interface ApplicationFeeValueOneOf {
-    /** Amount of the application fee in `0.00` format. */
+    /**
+     * Amount of the application fee in `0.00` format.
+     * @format DECIMAL_VALUE
+     */
     amount?: string;
 }
 export interface SpecificDateSubscriptionUpdateData {
@@ -835,164 +977,41 @@ export interface SpecificDateSubscriptionUpdateData {
     executionDate?: Date | null;
 }
 export interface PlatformOrigin {
+    /** @format GUID */
     appId?: string | null;
+    /** @format GUID */
     entityId?: string | null;
 }
-export interface InvoiceMarkedAsPaid {
+export interface SubscriptionBillingCyclePaid {
     /** The subscription for which one of the invoices has been marked as paid */
     subscription?: Subscription;
     /** The cycle that has been marked as paid */
     paidCycle?: number;
-    /** The invoice ID that has been marked as paid */
+    /**
+     * The invoice ID that has been marked as paid
+     * @format GUID
+     */
     invoiceId?: string;
-    /** The transaction ID of the payment order that has been marked as paid */
-    paymentTransactionId?: string | null;
-}
-export interface ListSubscriptionHistoryRequest {
-    subscriptionId: string;
-    /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
-    mode?: HistoryViewMode;
-    /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
-    cursor?: CursorPaging;
-}
-export declare enum HistoryViewMode {
-    UNKNOWN = "UNKNOWN",
-    /** Comprehensive view including all history events. */
-    BACKOFFICE = "BACKOFFICE",
-    /** User-centric view of the history. */
-    USER = "USER"
-}
-export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
-    limit?: number | null;
     /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
-     * Not relevant for the first request.
+     * The transaction ID of the payment order that has been marked as paid
+     * @format GUID
      */
-    cursor?: string | null;
-}
-export interface ListSubscriptionHistoryResponse {
-    /** List of history entries for the subscription. */
-    historyEntries?: SubscriptionHistoryEntry[];
-    /** Paging metadata. A `next` cursor is returned if there are more results. */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface SubscriptionHistoryEntry {
-    entryId?: string;
-    /** TODO: add max length? it is not defined in domainevents, so should we? */
-    slug?: string;
-    entryTime?: Date | null;
-    event?: SubscriptionEvent;
-}
-export interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
-    created?: SubscriptionCreated;
-    updated?: SubscriptionUpdated;
-    deleted?: SubscriptionDeleted;
-    activated?: SubscriptionActivated;
-    ended?: SubscriptionEnded;
-    canceled?: SubscriptionCanceled;
-    paused?: SubscriptionPaused;
-    resumed?: SubscriptionResumed;
-    pauseRequested?: PauseSubscriptionRequested;
-    resumeRequested?: ResumeSubscriptionRequested;
-    scheduledPauseCanceled?: ScheduledPauseCanceled;
-    scheduledResumeCanceled?: ScheduledResumeCanceled;
-    billingCycleStarted?: SubscriptionBillingCycleStarted;
-    autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
-    autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
-    cycleReadyToPay?: SubscriptionCycleReadyToPay;
-    extended?: SubscriptionExtended;
-    initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
-    latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
-    revived?: SubscriptionRevived;
-    billingDateUpdated?: SubscriptionBillingDateUpdated;
-    futureUpdatesRequested?: FutureUpdatesRequested;
-    updatesApplied?: UpdatesApplied;
-    resetPendingUpdates?: ResetPendingUpdates;
-    gracePeriodStarted?: GracePeriodStarted;
-    gracePeriodEnded?: GracePeriodEnded;
-    paymentMethodUpdated?: PaymentMethodUpdated;
-    collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
-    freeTrailStarted?: FreeTrailStarted;
-    freeTrailEnded?: FreeTrailEnded;
-    invoiceMarkedAsPaid?: InvoiceMarkedAsPaid;
-    initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
-    subscriptionBoAction?: SubscriptionBackOfficeAction;
-    unknown?: UnknownSubscriptionEvent;
+    paymentTransactionId?: string | null;
 }
-/** @oneof */
-export interface SubscriptionEventPayloadOneOf {
-    created?: SubscriptionCreated;
-    updated?: SubscriptionUpdated;
-    deleted?: SubscriptionDeleted;
-    activated?: SubscriptionActivated;
-    ended?: SubscriptionEnded;
-    canceled?: SubscriptionCanceled;
-    paused?: SubscriptionPaused;
-    resumed?: SubscriptionResumed;
-    pauseRequested?: PauseSubscriptionRequested;
-    resumeRequested?: ResumeSubscriptionRequested;
-    scheduledPauseCanceled?: ScheduledPauseCanceled;
-    scheduledResumeCanceled?: ScheduledResumeCanceled;
-    billingCycleStarted?: SubscriptionBillingCycleStarted;
-    autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
-    autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
-    cycleReadyToPay?: SubscriptionCycleReadyToPay;
-    extended?: SubscriptionExtended;
-    initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
-    latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
-    revived?: SubscriptionRevived;
-    billingDateUpdated?: SubscriptionBillingDateUpdated;
-    futureUpdatesRequested?: FutureUpdatesRequested;
-    updatesApplied?: UpdatesApplied;
-    resetPendingUpdates?: ResetPendingUpdates;
-    gracePeriodStarted?: GracePeriodStarted;
-    gracePeriodEnded?: GracePeriodEnded;
-    paymentMethodUpdated?: PaymentMethodUpdated;
-    collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
-    freeTrailStarted?: FreeTrailStarted;
-    freeTrailEnded?: FreeTrailEnded;
-    invoiceMarkedAsPaid?: InvoiceMarkedAsPaid;
-    initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
-    subscriptionBoAction?: SubscriptionBackOfficeAction;
-    unknown?: UnknownSubscriptionEvent;
+export interface GetSubscriptionRequest {
+    /** @format GUID */
+    id: string;
 }
-export interface SubscriptionCreated {
+export interface GetSubscriptionResponse {
     subscription?: Subscription;
 }
-export interface SubscriptionUpdated {
-    current?: Subscription;
-    previous?: Subscription;
-    diff?: SubscriptionDiff;
-}
-export interface SubscriptionDiff {
-    added?: string | null;
-    changed?: string | null;
-    deleted?: string | null;
-}
-export interface SubscriptionDeleted {
-    subscriptionId?: string;
-}
-/**
- * Sent each time a subscription status has been set to Active
- * Active shows that a subscription is live and operational.
- * For example:
- * * For subscription with free trial, free trial start date is also the activation date.
- * * For a subscription with future start date, the start date is also the activation date.
- * * When a subscription is resumed from a pause status, the resume date is also the activation date.
- */
-export interface SubscriptionActivated {
-    subscription?: Subscription;
+export interface CustomerCancelSubscriptionRequest {
+    /** @format GUID */
+    id: string;
+    /** Optional action reason message */
+    reason?: string | null;
 }
-/**
- * Sent each time a subscription status has been set to Ended
- * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
- * This is different from a Canceled subscription which ends the subscription before a designated end date.
- * Therefore, Ended and Canceled are mutually exclusive.
- */
-export interface SubscriptionEnded {
+export interface CustomerCancelSubscriptionResponse {
     subscription?: Subscription;
 }
 /**
@@ -1010,53 +1029,45 @@ export interface ActionDetails {
     initiator?: HistoryActionInitiator;
     reason?: string | null;
 }
-export interface SubscriptionPaused {
-    subscription?: Subscription;
-    pausePolicy?: PausePolicy;
-    actionDetails?: ActionDetails;
-}
-export interface SubscriptionResumed {
-    subscription?: Subscription;
-    actionDetails?: ActionDetails;
-}
-export interface PauseSubscriptionRequested {
-    subscription?: Subscription;
-    pauseAt?: PauseAt;
-    pausePolicy?: PausePolicy;
-    actionDetails?: ActionDetails;
+export interface CustomerTurnOnAutoRenewalRequest {
+    /** @format GUID */
+    id: string;
+    /** Optional action reason message */
+    reason?: string | null;
 }
-export interface ResumeSubscriptionRequested {
+export interface CustomerTurnOnAutoRenewalResponse {
     subscription?: Subscription;
-    resumeAt?: ResumeAt;
-    actionDetails?: ActionDetails;
 }
-export interface ScheduledPauseCanceled {
-    subscription?: Subscription;
-    actionDetails?: ActionDetails;
+export interface CustomerTurnOffAutoRenewalRequest {
+    /** @format GUID */
+    id: string;
+    /** Optional action reason message */
+    reason?: string | null;
 }
-export interface ScheduledResumeCanceled {
+export interface CustomerTurnOffAutoRenewalResponse {
     subscription?: Subscription;
-    actionDetails?: ActionDetails;
 }
-export interface SubscriptionBillingCycleStarted {
-    subscription?: Subscription;
-    /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
-    paymentTransactionId?: string | null;
+export interface CustomerExtendSubscriptionRequest {
+    /**
+     * The ID of the subscription to be extended
+     * @format GUID
+     */
+    id: string;
+    /** Optional action reason message */
+    reason?: string | null;
+    /**
+     * For termed - Subscription end date will be updated with the extension period and number of cycles will be added
+     * @min 1
+     */
+    billingCyclesToAdd: number | null;
 }
-export interface SubscriptionAutoRenewalTurnedOn {
+export interface CustomerExtendSubscriptionResponse {
+    /** The now extended subscription */
     subscription?: Subscription;
-    actionDetails?: ActionDetails;
 }
-export interface SubscriptionAutoRenewalTurnedOff {
-    subscription?: Subscription;
-    actionDetails?: ActionDetails;
-}
-export interface SubscriptionCycleReadyToPay {
-    subscription?: Subscription;
-}
-export interface SubscriptionExtended extends SubscriptionExtendedExtendPolicyOneOf {
-    extensionPeriod?: Duration;
-    extensionBillingCycles?: number;
+export interface SubscriptionExtended extends SubscriptionExtendedExtendPolicyOneOf {
+    extensionPeriod?: Duration;
+    extensionBillingCycles?: number;
     subscription?: Subscription;
     actionDetails?: ActionDetails;
 }
@@ -1065,98 +1076,75 @@ export interface SubscriptionExtendedExtendPolicyOneOf {
     extensionPeriod?: Duration;
     extensionBillingCycles?: number;
 }
-export interface SubscriptionInitialPurchaseCompleted {
-    subscription?: Subscription;
-    actionDetails?: ActionDetails;
-    paymentTransactionId?: string | null;
-}
-export interface LatestInvoiceMarkedAsPaid {
-    subscription?: Subscription;
-}
-export interface SubscriptionRevived {
-    subscription?: Subscription;
-}
-export interface SubscriptionBillingDateUpdated {
-    subscription?: Subscription;
-    billingDate?: Date | null;
-    proration?: Proration;
-}
-export interface FutureUpdatesRequested {
-    subscription?: Subscription;
-    requestedUpdateData?: SubscriptionUpdateData;
-}
-export interface UpdatesApplied {
-    subscription?: Subscription;
-    updateAction?: UpdateAction;
-    appliedUpdateData?: SubscriptionUpdateData;
-}
-export declare enum UpdateAction {
-    NONE = "NONE",
-    /** Update subscription immediately, please note proration for updates changing price are not yet supported */
-    IMMEDIATELY = "IMMEDIATELY",
-    /** Request updates that will take affect only at the start of the next billing cycle. */
-    NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
-    /** Reset all pending updates */
-    RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
-    /** Request updates that will take affect only at a specific date. */
-    SPECIFIC_DATE = "SPECIFIC_DATE"
-}
-export interface ResetPendingUpdates {
-    subscription?: Subscription;
-}
-export interface GracePeriodStarted {
-    subscription?: Subscription;
-}
-export interface GracePeriodEnded {
-    subscription?: Subscription;
-    /** Indication for the payment settlement method. */
-    paymentSettlementMethod?: PaymentSettlementMethod;
-}
-export declare enum PaymentSettlementMethod {
-    UNKNOWN = "UNKNOWN",
-    /** System-defined payment settlement. */
-    SYSTEM = "SYSTEM",
-    /** Manually mark the payment as paid. */
-    MARK_AS_PAID = "MARK_AS_PAID",
-    /** Require the customer to pay immediately, by insert a new payment method. */
-    CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
-}
-export interface PaymentMethodUpdated {
-    subscription?: Subscription;
-    initiator?: HistoryActionInitiator;
-    paymentMode?: PaymentMode;
+export interface QuerySubscriptionsRequest {
+    query?: QueryV2;
 }
-export declare enum PaymentMode {
-    NONE = "NONE",
-    /** The latest invoice of the subscription will be charged. */
-    CHARGE = "CHARGE",
-    /** An authorization invoice with zero amount will be created. */
-    AUTHORIZATION = "AUTHORIZATION"
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
 }
-export interface SubscriptionCollectionMethodUpdated {
-    subscription?: Subscription;
-    newCollectionMethod?: CollectionMethodEnumCollectionMethod;
-    previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
+/** @oneof */
+export interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
 }
-export interface FreeTrailStarted {
-    subscription?: Subscription;
+export interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
 }
-export interface FreeTrailEnded {
-    subscription?: Subscription;
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
 }
-export interface InitiatedPaymentMethodSetup {
-    subscription?: Subscription;
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
 }
-export interface SubscriptionBackOfficeAction {
-    subscription?: Subscription;
-    /** The backoffice method name */
-    name?: string;
-    /** json as string format, to store the flatted request object */
-    params?: string;
+export interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
 }
-/** Defines unknown events restored from the logs */
-export interface UnknownSubscriptionEvent {
-    subscriptionAsString?: string | null;
+export interface QuerySubscriptionsResponse {
+    subscriptions?: Subscription[];
+    metadata?: PagingMetadataV2;
 }
 export interface PagingMetadataV2 {
     /** Number of items returned in the response. */
@@ -1171,292 +1159,100 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
+export interface CountSubscriptionsRequest {
+    /** Filters to specify which subscriptions are counted. */
+    filter?: CountSubscriptionFilter;
+}
+export interface CountSubscriptionFilter extends CountSubscriptionFilterStatusOneOf {
+    /** List of statuses to filter the counted subscriptions by. */
+    statuses?: SubscriptionStatus;
     /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
+     * Predefined status combination to filter the counted subscriptions by.
+     * + `ALL`: Includes these subscription statuses: `"DRAFT"`, `"PENDING"`, `"ACTIVE"`, `"PAUSED"`, `"ENDED"`, and `"CANCELED"`.
+     * + `LIVE`: Includes these subscription statuses: `"PENDING"`, `"ACTIVE"`, and `"PAUSED"`.
      */
-    id?: string;
+    statusGroup?: SubscriptionStatusGroup;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * Customer ID to filter the counted subscriptions by. You can pass a
+     * [member ID](https://bo.wix.com/wix-docs/rest/members/members/member-object),
+     * [contact ID](https://bo.wix.com/wix-docs/rest/crm/contacts/contacts-v4/contact-object),
+     * or the ID of an anonymous site visitor as `customerId`. When providing a
+     * `customerId` you must also specify a `paymentMethodId`.
+     * @format GUID
      */
-    entityFqdn?: string;
+    customerId?: string | null;
     /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
+     * ID of the payment method to filter the counted subscriptions by.
+     * You must provide a `paymentMethodId` when passing a `customerId`.
+     * @format GUID
      */
-    slug?: string;
-    /** ID of the entity associated with the event. */
-    entityId?: string;
-    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
-    eventTime?: Date | null;
+    paymentMethodId?: string | null;
+}
+/** @oneof */
+export interface CountSubscriptionFilterStatusOneOf {
+    /** List of statuses to filter the counted subscriptions by. */
+    statuses?: SubscriptionStatus;
     /**
-     * Whether the event was triggered as a result of a privacy regulation application
-     * (for example, GDPR).
+     * Predefined status combination to filter the counted subscriptions by.
+     * + `ALL`: Includes these subscription statuses: `"DRAFT"`, `"PENDING"`, `"ACTIVE"`, `"PAUSED"`, `"ENDED"`, and `"CANCELED"`.
+     * + `LIVE`: Includes these subscription statuses: `"PENDING"`, `"ACTIVE"`, and `"PAUSED"`.
      */
-    triggeredByAnonymizeRequest?: boolean | null;
-    /** If present, indicates the action that triggered the event. */
-    originatedFrom?: string | null;
+    statusGroup?: SubscriptionStatusGroup;
+}
+export interface SubscriptionStatus {
     /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     * Statuses to filter the counted subscriptions by.
+     *
+     * Max: 6 statuses
+     * @maxSize 6
      */
-    entityEventSequence?: string | null;
+    statuses?: SubscriptionStatusEnumSubscriptionStatus[];
 }
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
+export declare enum SubscriptionStatusGroup {
+    ALL = "ALL",
+    /** Union of ACTIVE, PAUSED and PENDING */
+    LIVE = "LIVE"
 }
-export interface EntityCreatedEvent {
-    entityAsJson?: string;
-    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
-    restoreInfo?: RestoreInfo;
+export interface CountSubscriptionsResponse {
+    /**
+     * List of statuses and the corresponding number of subscriptions that match
+     * the filters.
+     */
+    countByStatus?: CountByStatus[];
+    /** Total number of subscriptions that match the filters. */
+    total?: number;
 }
-export interface RestoreInfo {
-    deletedDate?: Date | null;
+export interface CountByStatus {
+    /** Subscription status. */
+    status?: SubscriptionStatusEnumSubscriptionStatus;
+    /** Number of subscriptions with the status that match the filters. */
+    count?: number;
 }
-export interface EntityUpdatedEvent {
+export interface UpdateSubscriptionPaymentMethodRequest {
     /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     * Subscription ID
+     * @format GUID
      */
-    currentEntityAsJson?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted */
-    deletedEntityAsJson?: string | null;
-}
-export interface ActionEvent {
-    bodyAsJson?: string;
-}
-export interface MessageEnvelope {
-    /** App instance ID. */
-    instanceId?: string | null;
-    /** Event type. */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityType;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-export interface GetSubscriptionRequest {
-    id: string;
-}
-export interface GetSubscriptionResponse {
-    subscription?: Subscription;
-}
-export interface CustomerCancelSubscriptionRequest {
-    id: string;
-    /** Optional action reason message */
-    reason?: string | null;
-}
-export interface CustomerCancelSubscriptionResponse {
-    subscription?: Subscription;
-}
-export interface CustomerTurnOnAutoRenewalRequest {
-    id: string;
-    /** Optional action reason message */
-    reason?: string | null;
-}
-export interface CustomerTurnOnAutoRenewalResponse {
-    subscription?: Subscription;
-}
-export interface CustomerTurnOffAutoRenewalRequest {
-    id: string;
-    /** Optional action reason message */
-    reason?: string | null;
-}
-export interface CustomerTurnOffAutoRenewalResponse {
-    subscription?: Subscription;
-}
-export interface CustomerExtendSubscriptionRequest {
-    /** The ID of the subscription to be extended */
-    id: string;
-    /** Optional action reason message */
-    reason?: string | null;
-    /** For termed - Subscription end date will be updated with the extension period and number of cycles will be added */
-    billingCyclesToAdd: number | null;
-}
-export interface CustomerExtendSubscriptionResponse {
-    /** The now extended subscription */
-    subscription?: Subscription;
-}
-export interface QuerySubscriptionsRequest {
-    query?: QueryV2;
-}
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object.
-     *
-     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object.
-     *
-     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
-     */
-    sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fieldsets?: string[];
-}
-/** @oneof */
-export interface QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface QuerySubscriptionsResponse {
-    subscriptions?: Subscription[];
-    metadata?: PagingMetadataV2;
-}
-export interface CountSubscriptionsRequest {
-    /** Filters to specify which subscriptions are counted. */
-    filter?: CountSubscriptionFilter;
-}
-export interface CountSubscriptionFilter extends CountSubscriptionFilterStatusOneOf {
-    /** List of statuses to filter the counted subscriptions by. */
-    statuses?: SubscriptionStatus;
-    /**
-     * Predefined status combination to filter the counted subscriptions by.
-     * + `ALL`: Includes these subscription statuses: `"DRAFT"`, `"PENDING"`, `"ACTIVE"`, `"PAUSED"`, `"ENDED"`, and `"CANCELED"`.
-     * + `LIVE`: Includes these subscription statuses: `"PENDING"`, `"ACTIVE"`, and `"PAUSED"`.
-     */
-    statusGroup?: SubscriptionStatusGroup;
-    /**
-     * Customer ID to filter the counted subscriptions by. You can pass a
-     * [member ID](https://bo.wix.com/wix-docs/rest/members/members/member-object),
-     * [contact ID](https://bo.wix.com/wix-docs/rest/crm/contacts/contacts-v4/contact-object),
-     * or the ID of an anonymous site visitor as `customerId`. When providing a
-     * `customerId` you must also specify a `paymentMethodId`.
-     */
-    customerId?: string | null;
-    /**
-     * ID of the payment method to filter the counted subscriptions by.
-     * You must provide a `paymentMethodId` when passing a `customerId`.
-     */
-    paymentMethodId?: string | null;
-}
-/** @oneof */
-export interface CountSubscriptionFilterStatusOneOf {
-    /** List of statuses to filter the counted subscriptions by. */
-    statuses?: SubscriptionStatus;
-    /**
-     * Predefined status combination to filter the counted subscriptions by.
-     * + `ALL`: Includes these subscription statuses: `"DRAFT"`, `"PENDING"`, `"ACTIVE"`, `"PAUSED"`, `"ENDED"`, and `"CANCELED"`.
-     * + `LIVE`: Includes these subscription statuses: `"PENDING"`, `"ACTIVE"`, and `"PAUSED"`.
-     */
-    statusGroup?: SubscriptionStatusGroup;
-}
-export interface SubscriptionStatus {
-    /**
-     * Statuses to filter the counted subscriptions by.
-     *
-     * Max: 6 statuses
-     */
-    statuses?: SubscriptionStatusEnumSubscriptionStatus[];
-}
-export declare enum SubscriptionStatusGroup {
-    ALL = "ALL",
-    /** Union of ACTIVE, PAUSED and PENDING */
-    LIVE = "LIVE"
-}
-export interface CountSubscriptionsResponse {
-    /**
-     * List of statuses and the corresponding number of subscriptions that match
-     * the filters.
-     */
-    countByStatus?: CountByStatus[];
-    /** Total number of subscriptions that match the filters. */
-    total?: number;
-}
-export interface CountByStatus {
-    /** Subscription status. */
-    status?: SubscriptionStatusEnumSubscriptionStatus;
-    /** Number of subscriptions with the status that match the filters. */
-    count?: number;
-}
-export interface UpdateSubscriptionPaymentMethodRequest {
-    /** Subscription ID */
     id: string;
+    /** @format GUID */
     paymentMethodId: string;
 }
 export interface UpdateSubscriptionPaymentMethodResponse {
     subscription?: Subscription;
 }
 export interface CustomerAllowedActionsRequest {
+    /** @format GUID */
     id: string;
 }
 export interface CustomerAllowedActionsResponse {
@@ -1490,7 +1286,10 @@ export declare enum ExtendPolicyType {
     BILLING_CYCLE = "BILLING_CYCLE"
 }
 export interface CustomerListUpcomingChargesRequest {
-    /** Subscription id upcoming charge to be previewed for */
+    /**
+     * Subscription id upcoming charge to be previewed for
+     * @format GUID
+     */
     id: string;
 }
 export interface CustomerListUpcomingChargesResponse {
@@ -1517,11 +1316,15 @@ export interface InvoiceItem extends InvoiceItemPaymentTypeOneOf {
      * time, not on a recurring basis.
      */
     oneTime?: OneTime;
-    /** ID of the invoice line item. */
+    /**
+     * ID of the invoice line item.
+     * @format GUID
+     */
     id?: string;
     /**
      * ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
      * that belongs to the invoice line item.
+     * @format GUID
      */
     subscriptionId?: string | null;
     /**
@@ -1529,12 +1332,15 @@ export interface InvoiceItem extends InvoiceItemPaymentTypeOneOf {
      * Typically the product name.
      *
      * Max: 200 characters
+     * @minLength 1
+     * @maxLength 200
      */
     name?: string;
     /**
      * Description of the invoice line item.
      *
      * Max: 500 characters
+     * @maxLength 500
      */
     description?: string | null;
     /** Information about the product from the external product catalog. */
@@ -1582,6 +1388,7 @@ export interface PriceDetails {
     /**
      * Price of the invoice line item in `0.00` format.
      * A minus sign (-) indicates that the amount is negative.
+     * @format DECIMAL_VALUE
      */
     price?: string;
     /** Information about the invoice line item's tax. */
@@ -1600,6 +1407,7 @@ export interface InvoiceDiscount extends InvoiceDiscountValueOneOf {
      * Available when the discount is an amount.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -1608,6 +1416,7 @@ export interface InvoiceDiscount extends InvoiceDiscountValueOneOf {
      *
      * Min: `0.01`
      * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
      */
     percentage?: string;
     /** Indicates the source of the discount. . Contains app_id and entity_id */
@@ -1620,6 +1429,7 @@ export interface InvoiceDiscountValueOneOf {
      * Available when the discount is an amount.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -1628,6 +1438,7 @@ export interface InvoiceDiscountValueOneOf {
      *
      * Min: `0.01`
      * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
      */
     percentage?: string;
 }
@@ -1636,6 +1447,7 @@ export interface InvoiceApplicationFee extends InvoiceApplicationFeeValueOneOf {
      * Application fee amount. Set by the origin app, and not by BASS. Wix
      * receives the full `applicationFee`, while the merchant doesn't receive
      * any portion of it.
+     * @format DECIMAL_VALUE
      */
     amount?: string;
     /** Information about the discount for the invoice line item's application fee. */
@@ -1647,34 +1459,63 @@ export interface InvoiceApplicationFeeValueOneOf {
      * Application fee amount. Set by the origin app, and not by BASS. Wix
      * receives the full `applicationFee`, while the merchant doesn't receive
      * any portion of it.
+     * @format DECIMAL_VALUE
      */
     amount?: string;
 }
 export interface ItemTaxData {
     /** Aggregated tax from tax_breakdowns */
     lineItemTaxSummary?: LineItemTaxSummary;
-    /** A detailed description of all the tax authorities applied on this item. */
+    /**
+     * A detailed description of all the tax authorities applied on this item.
+     * @minSize 1
+     * @maxSize 100
+     */
     taxBreakdowns?: TaxBreakdown[];
 }
 export interface LineItemTaxSummary {
-    /** Calculated from external tax summary */
+    /**
+     * Calculated from external tax summary
+     * @format DECIMAL_VALUE
+     */
     aggregatedTaxAmount?: string;
-    /** Aggregated from tax_breakdowns */
+    /**
+     * Aggregated from tax_breakdowns
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
     aggregatedTaxRate?: string;
-    /** Total taxable amount for this line item. */
+    /**
+     * Total taxable amount for this line item.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     taxableAmount?: string;
-    /** Aggregated from tax_breakdowns after applying exemptions */
+    /**
+     * Aggregated from tax_breakdowns after applying exemptions
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     finalTaxAmount?: string | null;
 }
 export interface TaxBreakdown {
     taxType?: string;
+    /** @decimalValue options { maxScale:4 } */
     taxRate?: string;
+    /** @format DECIMAL_VALUE */
     taxAmount?: string | null;
+    /** @format DECIMAL_VALUE */
     taxableAmount?: string | null;
+    /** @format DECIMAL_VALUE */
     nonTaxableAmount?: string | null;
-    /** Name of the tax that was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. */
+    /**
+     * Name of the tax that was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
+     * @maxLength 200
+     */
     taxName?: string | null;
-    /** Jurisdiction that taxes were calculated for. */
+    /**
+     * Jurisdiction that taxes were calculated for.
+     * @maxLength 200
+     */
     jurisdiction?: string | null;
     /** Type of jurisdiction that taxes were calculated for. */
     jurisdictionType?: string;
@@ -1684,6 +1525,13 @@ export interface InitiatePaymentMethodSetupRequest {
     paymentMode?: PaymentMode;
     paymentSettings?: PaymentSettings;
 }
+export declare enum PaymentMode {
+    NONE = "NONE",
+    /** The latest invoice of the subscription will be charged. */
+    CHARGE = "CHARGE",
+    /** An authorization invoice with zero amount will be created. */
+    AUTHORIZATION = "AUTHORIZATION"
+}
 export interface PaymentSettings {
     /** Allowed payment providers for Subscriptions, for example to limit subscriptions to be created only with "Wix Payments" provider. */
     allowedProviderIds?: string[];
@@ -1691,6 +1539,7 @@ export interface PaymentSettings {
     orderMethod?: OrderMethod;
     /** Wix Pay callback url(s) to return buyer to a third party system */
     redirectUrls?: RedirectUrls;
+    /** @format GUID */
     paymentMethodId?: string | null;
     /**
      * Specifies an alternative origin for processing the payment.
@@ -1718,441 +1567,1130 @@ export interface RedirectUrls {
     pendingUrl?: string;
 }
 export interface PaymentOrigin {
-    /** ID of the app for which the Payment will create the order on. For example, Paypal. */
+    /**
+     * ID of the app for which the Payment will create the order on. For example, Paypal.
+     * @format GUID
+     */
     appId?: string;
-    /** Id of the entity that order will be created on */
+    /**
+     * Id of the entity that order will be created on
+     * @format GUID
+     */
     instanceId?: string;
 }
 export interface InitiatePaymentMethodSetupResponse {
+    /** @format GUID */
     paymentOrderId?: string;
 }
-export interface SetIsMigratedEvent {
-    subscriptionId?: string;
-}
-export interface SubscriptionDelayedSyncEvent {
-    subscriptionId?: string;
-}
-export interface InvoiceAction extends InvoiceActionActionTypeOneOf {
-    payRecurring?: PayRecurringInvoice;
-}
-/** @oneof */
-export interface InvoiceActionActionTypeOneOf {
-    payRecurring?: PayRecurringInvoice;
-}
-export interface PayRecurringInvoice {
-    invoiceId?: string;
-}
-export interface CreateSubscriptionRequest {
-    subscription?: Subscription;
-    /** Optional settings for the payments. Should be empty for free subscriptions. */
-    paymentSettings?: PaymentSettings;
-    /** Optional unique identifier for this request in order to prevent subscription duplications */
-    idempotencyKey?: string | null;
-    /** Optional origin override for setting identity of subscription creator instead of extracting from context */
-    originOverride?: OriginOverride;
-}
-export interface OriginOverride {
-    appId?: string;
-    instanceId?: string;
-}
-export interface CreateSubscriptionResponse {
-    subscription?: Subscription;
-    /** Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions. */
-    paymentOrderId?: string | null;
-}
-export interface UpdateSubscriptionRequest {
-    /** Revision is validated if Subscription.revision is set */
-    subscription?: Subscription;
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
     /**
-     * Supported field: start_date
-     * Can be updated only if Subscription is in Draft state
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
      */
-    fieldMask?: string[];
-}
-export interface UpdateSubscriptionResponse {
-    subscription?: Subscription;
-}
-export interface UpdateSubscriptionStartDateRequest {
-    /** Subscription ID */
     id?: string;
     /**
-     * Can be updated only if Subscription is in Draft state
-     * By setting start_date in the future, end_date will be recalculated for termed Subscriptions
-     * cycles_to_pay_on_creation will be set to 1 if no free trial is set
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
      */
-    startDate?: Date | null;
-}
-export interface UpdateSubscriptionStartDateResponse {
-    subscription?: Subscription;
-}
-export interface UpdateSubscriptionPoliciesRequest {
-    /** Subscription ID */
-    id?: string;
-    cancellableByCustomer?: boolean | null;
-}
-export interface UpdateSubscriptionPoliciesResponse {
-    /** Updated policies of the subscription */
-    policies?: SubscriptionPolicies;
-}
-export interface UpdateSubscriptionBillingDateRequest {
-    /** ID of the subscription to update the billing date for. */
-    id: string;
-    /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
-    billingDate: Date | null;
+    entityFqdn?: string;
     /**
-     * Information about how BASS adjusts the total of the next invoice. Extending
-     * the current billing cycle results in a higher payment, while shortening it
-     * leads to a lower payment. BASS offers automatic calculation of the proration
-     * amount based on the number of days added to or removed from the current billing
-     * cycle. Alternatively, you can use your own custom method to calculate the
-     * proration amount. The custom proration amount can't exceed the total of the
-     * current billing cycle.
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
      */
-    proration?: Proration;
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
 }
-export interface UpdateSubscriptionBillingDateResponse {
-    /** Updated subscription. */
-    subscription?: Subscription;
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
 }
-export interface UpdateSubscriptionOriginRequest {
-    /** ID of the subscription to update origin. */
-    id?: string;
-    /** Origin entity ID of the subscription to update. */
-    entityId?: string;
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
 }
-export interface UpdateSubscriptionOriginResponse {
-    /** Updated subscription. */
-    subscription?: Subscription;
+export interface RestoreInfo {
+    deletedDate?: Date | null;
 }
-export interface ReviseSubscriptionRequest {
-    /** Subscription ID */
-    id?: string;
-    /** 0 for no revision, maxSize is 100 */
-    items?: Item[];
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
 }
-export interface ReviseSubscriptionResponse {
-    subscription?: Subscription;
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
 }
-export interface UpdateSubscriptionItemsRequest {
-    /** Subscription ID */
-    id?: string;
-    /** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
-    updateAction?: UpdateAction;
-    /** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
-    scheduleAdditionalInfo?: ScheduleAdditionalInfo;
-    /** Existing items to update */
-    itemsToUpdate?: ItemChange[];
-    /** Items to add */
-    itemsToAdd?: Item[];
-    /** Existing items to delete */
-    itemsToDelete?: string[] | null;
+export interface ActionEvent {
+    bodyAsJson?: string;
 }
-export interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
+export interface MessageEnvelope {
     /**
-     * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
-     * format. The use of this field may be restricted in various BASS endpoints.
-     * For example, in _Bulk Update Subscription Items_ it's only available in
-     * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
-     * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
-     * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
+     * App instance ID.
+     * @format GUID
      */
-    specificDate?: Date | null;
+    instanceId?: string | null;
     /**
-     * When the update becomes effective, as number of billing cycles from now.
-     * The use of this field may be restricted in various BASS endpoints.
-     * For example, in _Pause Subscription_ it's only available in
-     * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
-     * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
+     * Event type.
+     * @maxLength 150
      */
-    numberOfCycles?: number;
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
 }
-/** @oneof */
-export interface ScheduleAdditionalInfoParamOneOf {
+export interface IdentificationData extends IdentificationDataIdOneOf {
     /**
-     * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
-     * format. The use of this field may be restricted in various BASS endpoints.
-     * For example, in _Bulk Update Subscription Items_ it's only available in
-     * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
-     * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
-     * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
      */
-    specificDate?: Date | null;
+    anonymousVisitorId?: string;
     /**
-     * When the update becomes effective, as number of billing cycles from now.
-     * The use of this field may be restricted in various BASS endpoints.
-     * For example, in _Pause Subscription_ it's only available in
-     * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
-     * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    numberOfCycles?: number;
-}
-export interface UpdateSubscriptionItemsResponse {
-    subscription?: Subscription;
-}
-export interface BulkUpdateSubscriptionItemsByFilterRequest {
+    memberId?: string;
     /**
-     * Filter to identify the subscriptions for which items are updated. For
-     * supported fields see
-     * [Search and Query: Bulk Update Subscription Items By Filter](https://bo.wix.com/wix-docs/rest/drafts/subscriptions-by-billing-by-wix/search-and-query#drafts_subscriptions-by-billing-by-wix_search-and-query_bulk-update-subscription-items-by-filter).
-     * Sending an empty subscription filter results in a validation error.
-     * In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
-     * `subscriptionId` field inside this filter. Passing any other filter results
-     * in a failed validation error.
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    subscriptionFilter?: Record<string, any> | null;
+    wixUserId?: string;
     /**
-     * Filter to specify which subscription items are updated. Make sure to use
-     * the catalog item ID and not the item's unique ID. All subscription items
-     * with matching `items.catalogReference.catalogItemId` are updated.
-     *
-     * Max: `100` reference catalog item IDs
+     * ID of an app.
+     * @format GUID
      */
-    catalogReferenceIds?: string[] | null;
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
     /**
-     * Information about the update timing and update type.
-     *
-     * + `"IMMEDIATELY"`: The updates become effective immediately.
-     * + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
-     * + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
-     * + `"RESET_PENDING_UPDATES"`: All currently scheduled updates for the specified supcriptions are canceled. Use only the `subscriptionId` field inside `subscriptionFilter`, all other filters result in failed validation errors.
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
      */
-    updateAction?: UpdateAction;
+    anonymousVisitorId?: string;
     /**
-     * Additional information for updates. Currently, only supported for
-     * `{"updateAction": "SPECIFIC_DATE"}`.
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
      */
-    scheduleAdditionalInfo?: ScheduleAdditionalInfo;
+    memberId?: string;
     /**
-     * Update details for the susbcription items that match the filtering.
-     * Currently, you can update only the item price, quantity, and tax. Note
-     * that all item properties are updated to the same values. In case you want set
-     * different values for individual items, you must call
-     * _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
      */
-    bulkItemUpdateData?: BulkItemChange;
-    /** __Not implemented yet__. Items to add to the subscriptions matching the filtering. */
-    itemsToAdd?: Item[];
-}
-export interface BulkItemChange {
-    /** Information about the new item price. */
-    pricingModel?: PricingModel;
+    wixUserId?: string;
     /**
-     * New item quantity.
-     *
-     * Min: `1`
+     * ID of an app.
+     * @format GUID
      */
-    quantity?: number | null;
-    /** Information about the new item tax. */
-    tax?: Tax;
+    appId?: string;
 }
-export interface BulkUpdateSubscriptionItemsByFilterResponse {
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
+    activeSubscription?: CreateSubscriptionRequest;
+}
+/** @oneof */
+export interface CreateSubscriptionInStateRequestModeOneOf {
+    activeSubscription?: CreateSubscriptionRequest;
+}
+export interface CreateSubscriptionRequest {
+    subscription?: Subscription;
+    /** Optional settings for the payments. Should be empty for free subscriptions. */
+    paymentSettings?: PaymentSettings;
     /**
-     * ID of your bulk job. You can use
-     * [this Async Infra call](https://pbo.wix.com/fire-console/?artifact=com.wixpress.asyncinfra.async-job-service&service=wix.infra.asyncjobs.v1.AsyncJobService&method=ListAsyncJobItems&body=eyJqb2JfaWQiOiIifQ%3D%3D)
-     * to retrieve information about the job status.
+     * Optional unique identifier for this request in order to prevent subscription duplications
+     * @format GUID
      */
-    jobId?: string;
-}
-export interface DeleteSubscriptionRequest {
-    id?: string;
-    revision?: string;
+    idempotencyKey?: string | null;
+    /** Optional origin override for setting identity of subscription creator instead of extracting from context */
+    originOverride?: OriginOverride;
 }
-export interface DeleteSubscriptionResponse {
+export interface OriginOverride {
+    /** @format GUID */
+    appId?: string;
+    /** @format GUID */
+    instanceId?: string;
 }
-export interface CancelSubscriptionRequest {
-    id: string;
-    actionContext: ActionContext;
+export interface CreateSubscriptionInStateResponse {
+    /** @format GUID */
+    subscriptionId?: string;
 }
-export interface ActionContext {
-    initiator?: ActionInitiator;
-    /** Optional action reason message */
-    reason?: string | null;
+export interface PayCycleRequest {
+    /** @format GUID */
+    subscriptionId: string;
+    paymentTestMode?: PaymentTestMode;
+    /** @format GUID */
+    tenantId: string;
 }
-export declare enum ActionInitiator {
-    UNDEFINED = "UNDEFINED",
-    BUSINESS = "BUSINESS",
-    CUSTOMER = "CUSTOMER",
-    SYSTEM = "SYSTEM"
+export declare enum PaymentTestMode {
+    REGULAR = "REGULAR",
+    FAIL_TECHNICAL = "FAIL_TECHNICAL",
+    FAIL_DECLINE = "FAIL_DECLINE",
+    FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
 }
-export interface CancelSubscriptionResponse {
+export interface PayCycleResponse {
+    /** @format GUID */
+    invoiceId?: string;
+    /** @format GUID */
+    paymentOrderId?: string | null;
     subscription?: Subscription;
 }
-export interface PauseSubscriptionRequest {
-    id: string;
-    pausePolicy?: PausePolicy;
-    pauseAt?: PauseAt;
-    /** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
-    pauseAtSchedule?: ScheduleAdditionalInfo;
-    /** contains additional scheduling information for certain auto_resume_at either specific date */
-    autoResumeAtSchedule?: ScheduleAdditionalInfo;
-    actionContext: ActionContext;
+export interface GetFullSubscriptionDataRequest {
+    /** @format GUID */
+    id?: string;
 }
-export interface PauseSubscriptionResponse {
+export interface GetFullSubscriptionDataResponse {
     subscription?: Subscription;
+    internalSubscriptionData?: InternalSubscriptionData;
 }
-export interface ResumeSubscriptionRequest {
-    id: string;
-    resumeAt?: ResumeAt;
-    /** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
-    resumeAtSchedule?: ScheduleAdditionalInfo;
-    actionContext: ActionContext;
-}
-export interface ResumeSubscriptionResponse {
-    subscription?: Subscription;
+export interface InternalSubscriptionData {
+    /** @format GUID */
+    originInstanceId?: string;
+    source?: string | null;
+    billingType?: string;
+    isOneTime?: boolean;
+    migrationDetails?: MigrationDetails;
+    pausePaidDuration?: string | null;
+    authorizationPaymentData?: PaymentData;
+    currentCyclePausePeriods?: PausePeriod[];
 }
-export interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
-    /** Limit number of results and enable to skip rows. The default limit is 25. */
-    paging?: Paging;
-    /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
-    cursor?: CursorPaging;
-    /** A filter object */
-    filter?: any;
-    /** A Sorting option by field name and order. */
-    sorting?: SortingClauses;
+export interface MigrationDetails {
+    /** system (application) where the Subscription has been created */
+    originSystem?: string;
+    /** date when the Subscription started to be managed in BASS */
+    shiftManagementDate?: Date | null;
 }
-/** @oneof */
-export interface SearchSubscriptionsRequestPagingMethodOneOf {
-    /** Limit number of results and enable to skip rows. The default limit is 25. */
-    paging?: Paging;
-    /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
-    cursor?: CursorPaging;
+export interface PausePeriod {
+    startDate?: Date | null;
+    endDate?: Date | null;
 }
-export interface SortingClauses {
-    sorting?: Sorting[];
+export interface GetSubscriptionAndInternalDataRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
 }
-export interface SearchSubscriptionsResponse {
-    subscriptions?: Subscription[];
-    cursor?: CursorPaging;
+export interface GetSubscriptionAndInternalDataResponse {
+    subscription?: Subscription;
+    internalSubscriptionData?: InternalSubscriptionData;
 }
-export interface TurnOnSubscriptionAutoRenewalRequest {
-    id: string;
-    actionContext: ActionContext;
+export interface SearchSubscriptionRequest {
+    /** @format GUID */
+    id?: string;
+    /** @format GUID */
+    tenantId?: string;
 }
-export interface TurnOnSubscriptionAutoRenewalResponse {
+export interface SearchSubscriptionResponse {
     subscription?: Subscription;
 }
-export interface TurnOffSubscriptionAutoRenewalRequest {
-    id: string;
-    actionContext: ActionContext;
+export interface UpdatePausePaidDurationRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /**
+     * @min 1
+     * @max 10000000
+     */
+    pausePaidDurationSeconds?: string;
+    /** @format GUID */
+    tenantId?: string;
 }
-export interface TurnOffSubscriptionAutoRenewalResponse {
+export interface UpdatePausePaidDurationResponse {
+}
+export interface UpdateStatusRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    status?: SubscriptionStatusEnumSubscriptionStatus;
+}
+export interface UpdateStatusResponse {
     subscription?: Subscription;
 }
-export interface MarkLatestInvoiceAsPaidRequest {
-    /** The ID of the offline subscription to mark as paid its latest invoice */
-    subscriptionId: string;
+export interface UpdatePaymentStatusRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    paymentStatus?: PaymentStatus;
 }
-export interface MarkLatestInvoiceAsPaidResponse {
+export interface UpdatePaymentStatusResponse {
     subscription?: Subscription;
 }
-export interface MultipleSubscriptionsOnOrdersInvoice {
-    /** the invoice id of the affected subscription */
-    invoiceId?: string;
-    /** the order id of the affected subscription */
-    orderId?: string;
+export interface ReviveSubscriptionRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    revivePolicy?: RevivePolicy;
+    isTestRun?: boolean;
 }
-export interface MarkInvoiceAsPaidRequest {
-    /** The ID of the subscription to mark as paid its invoice. */
-    subscriptionId: string;
-    /**
-     * The subscription cycle for which the invoice is to be marked as paid.
-     * If left empty, the most recent cycle will be selected.
-     */
-    paidCycle?: number | null;
+export declare enum RevivePolicy {
+    SIMPLE = "SIMPLE",
+    RESUME = "RESUME"
 }
-export interface MarkInvoiceAsPaidResponse {
+export interface ReviveSubscriptionResponse {
     subscription?: Subscription;
 }
-export interface GetSubscriptionsStatsRequest {
+export interface ConvertSapiRequest {
+    /** @format GUID */
+    subscriptionId?: string;
 }
-export interface GetSubscriptionsStatsResponse {
-    amountByStatuses?: AmountByStatus[];
-    total?: number;
+export interface ConvertSapiResponse {
+    subscription?: Subscription;
 }
-export interface AmountByStatus {
-    status?: SubscriptionStatusEnumSubscriptionStatus;
-    amount?: number;
+export interface GetSubscriptionInvoicesRequest {
+    /** @format GUID */
+    id?: string;
 }
-export interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
-    /** User won't be charged for additional period added on top of subscription end date. */
-    extensionPeriod?: Duration;
-    /** user will be charged for billing cycles added */
-    extensionBillingCycles?: number;
-    /** The ID of the subscription to be extended */
-    id: string;
-    actionContext: ActionContext;
+export interface GetSubscriptionInvoicesResponse {
+    invoices?: SubscriptionInvoice[];
 }
-/** @oneof */
-export interface ExtendSubscriptionRequestExtendPolicyOneOf {
-    /** User won't be charged for additional period added on top of subscription end date. */
-    extensionPeriod?: Duration;
-    /** user will be charged for billing cycles added */
-    extensionBillingCycles?: number;
+export interface SubscriptionInvoice {
+    /** @format GUID */
+    id?: string;
+    subscriptionCycle?: number;
+    createdDate?: Date | null;
 }
-export interface ExtendSubscriptionResponse {
-    /** The now extended subscription */
-    subscription?: Subscription;
+export interface FinishFreeTrialNowRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
 }
-export interface AllowedActionsRequest {
-    id: string;
-    /** List of additional fields to be included in the response. */
-    fields?: RequestedFields[];
+export interface FinishFreeTrialNowResponse {
+    subscription?: Subscription;
 }
-export declare enum RequestedFields {
-    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
-    /** Include unsupported action list, including the reasons for the lack of support */
-    UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
+export interface SendTimeCapsuleTaskCanceledBIRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @minLength 1 */
+    taskType?: string;
 }
-export interface AllowedActionsResponse {
-    /** List of actions that are allowed. */
-    actions?: Action[];
-    /** List of actions that are not supported, included only if requested. Provides reasons for each unsupported action. */
-    unsupportedActions?: UnsupportedAction[];
+export interface Empty {
 }
-export interface UnsupportedAction {
-    actionType?: ActionType;
-    /** Provides detailed reasons for the unsupported action. Each `UnsupportedReason` includes a code and a message explaining why the action is not allowed. */
-    reasons?: UnsupportedReason[];
+export interface ScheduleTimeCapsuleTaskRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @minLength 1 */
+    taskType?: string;
+    executionTime?: Date | null;
+    /** @format GUID */
+    tenantId?: string;
 }
-export interface UnsupportedReason {
-    code?: string;
-    description?: string | null;
+export interface CancelTimeCapsuleTaskRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @minLength 1 */
+    taskType?: string;
 }
-export interface ListUpcomingChargesRequest {
-    /** Subscription id charges to be previewed for */
-    subscriptionId: string;
-    /** Period of time to provide charged for. If not provided,then only next charge will be returned. */
-    customDuration?: Duration;
-    /**
-     * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
-     * If not provided, the upcoming charges will be calculated according to the existing next billing date.
-     */
-    nextBillingDate?: Date | null;
+export interface UpdateFullSubscriptionRequest {
+    /** @format GUID */
+    tenantId?: string;
+    subscription?: Subscription;
 }
-export interface ListUpcomingChargesResponse {
-    upcomingCharges?: SubscriptionCharge[];
+export interface UpdateFullSubscriptionResponse {
+    subscription?: Subscription;
 }
-export interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
-    /** Information about a non-existing subscription. */
-    subscriptionInfo?: SubscriptionInfo;
+export interface UpdateSubscriptionInvoiceCycleRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    invoiceId?: string;
+    subscriptionCycle?: number;
 }
-/** @oneof */
-export interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
-    /** Information about a non-existing subscription. */
-    subscriptionInfo?: SubscriptionInfo;
+export interface UpdateSubscriptionInvoiceCycleResponse {
+    subscriptionInvoice?: SubscriptionInvoice;
 }
-/** Subscription information to use for calculating the preview of charges for a subscription. */
-export interface SubscriptionInfo {
-    billingSettings?: BillingSettings;
-    items?: Item[];
-    startDate?: Date | null;
+export interface AddPausePeriodRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    pauseStartDate?: Date | null;
+    pauseEndDate?: Date | null;
 }
-export interface PreviewSubscriptionChargesResponse {
-    /** Charges for subscription. */
-    charges?: Charge[];
+export interface AddPausePeriodResponse {
+    subscription?: Subscription;
 }
-/** Represents a charge applicable to a subscription. */
-export interface Charge {
+export interface RunTimeCapsuleTaskNowRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @minLength 1 */
+    taskType?: string;
+}
+export interface CreateRecurringInvoiceBORequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    /** @min 2 */
+    cycleNumber?: number;
+}
+export interface CreateRecurringInvoiceBOResponse {
+    invoiceId?: string;
+}
+export interface SetShiftingDataRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    isBassManaged?: boolean;
+    shiftManagementDate?: Date | null;
+}
+export interface SetShiftingDataResponse {
+    subscription?: Subscription;
+}
+export interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
+    attachInvoice?: AttachInvoice;
+    detachInvoice?: DetachInvoice;
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+/** @oneof */
+export interface FixSubscriptionInvoicesRequestModeOneOf {
+    attachInvoice?: AttachInvoice;
+    detachInvoice?: DetachInvoice;
+}
+export interface AttachInvoice {
+    /** @format GUID */
+    invoiceId?: string;
+}
+export interface DetachInvoice {
+    /** @format GUID */
+    invoiceId?: string;
+}
+export interface FixSubscriptionInvoicesResponse {
+    invoices?: SubscriptionInvoice[];
+}
+export interface RestoreDraftSubscriptionRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+export interface RestoreDraftSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface DeleteDraftSubscriptionRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+export interface DeleteDraftSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface DeleteSubscriptionBORequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+export interface DeleteSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+export interface CancelSubscriptionBORequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    initiator?: ActionInitiator;
+    reason?: string | null;
+}
+export declare enum ActionInitiator {
+    UNDEFINED = "UNDEFINED",
+    BUSINESS = "BUSINESS",
+    CUSTOMER = "CUSTOMER",
+    SYSTEM = "SYSTEM"
+}
+export interface CancelSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+export interface UpdatePaymentMethodBORequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    paymentMethodId?: string;
+}
+export interface UpdatePaymentMethodBOResponse {
+    subscription?: Subscription;
+}
+export interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+/** @oneof */
+export interface SendSubscriptionActionEventBORequestEventOneOf {
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+}
+export interface SubscriptionBillingCycleStarted {
+    subscription?: Subscription;
+    /**
+     * Wix Pay transaction id, optional. Exists if event was triggered by a payment.
+     * @format GUID
+     */
+    paymentTransactionId?: string | null;
+}
+export interface SendSubscriptionActionEventResponse {
+}
+export interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    transactionId?: string;
+}
+export interface PauseSubscriptionBORequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    pausePolicy?: PausePolicy;
+    pauseAt?: PauseAt;
+    initiator?: ActionInitiator;
+    /** @maxLength 500 */
+    reason?: string | null;
+}
+export interface PauseSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+export interface SetIsMigratedEvent {
+    /** @format GUID */
+    subscriptionId?: string;
+}
+export interface SubscriptionDelayedSyncEvent {
+    /** @format GUID */
+    subscriptionId?: string;
+}
+export interface InvoiceAction extends InvoiceActionActionTypeOneOf {
+    payRecurring?: PayRecurringInvoice;
+}
+/** @oneof */
+export interface InvoiceActionActionTypeOneOf {
+    payRecurring?: PayRecurringInvoice;
+}
+export interface PayRecurringInvoice {
+    /** @format GUID */
+    invoiceId?: string;
+}
+/**
+ * Sent each time a subscription status has been set to Active
+ * Active shows that a subscription is live and operational.
+ * For example:
+ * * For subscription with free trial, free trial start date is also the activation date.
+ * * For a subscription with future start date, the start date is also the activation date.
+ * * When a subscription is resumed from a pause status, the resume date is also the activation date.
+ */
+export interface SubscriptionActivated {
+    subscription?: Subscription;
+}
+/**
+ * Sent each time a subscription status has been set to Ended
+ * Ended shows that a subscription reached its end date and ended its life cycle as a result of the agreement.
+ * This is different from a Canceled subscription which ends the subscription before a designated end date.
+ * Therefore, Ended and Canceled are mutually exclusive.
+ */
+export interface SubscriptionEnded {
+    subscription?: Subscription;
+}
+export interface SubscriptionInitialPurchaseCompleted {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+    /** @format GUID */
+    paymentTransactionId?: string | null;
+}
+export interface SubscriptionCycleReadyToPay {
+    subscription?: Subscription;
+}
+export interface SubscriptionRevived {
+    subscription?: Subscription;
+}
+export interface CreateSubscriptionResponse {
+    subscription?: Subscription;
+    /**
+     * Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions.
+     * @format GUID
+     */
+    paymentOrderId?: string | null;
+}
+export interface UpdateSubscriptionRequest {
+    /** Revision is validated if Subscription.revision is set */
+    subscription?: Subscription;
+    /**
+     * Supported field: start_date
+     * Can be updated only if Subscription is in Draft state
+     */
+    fieldMask?: string[];
+}
+export interface UpdateSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface UpdateSubscriptionStartDateRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * Can be updated only if Subscription is in Draft state
+     * By setting start_date in the future, end_date will be recalculated for termed Subscriptions
+     * cycles_to_pay_on_creation will be set to 1 if no free trial is set
+     */
+    startDate?: Date | null;
+}
+export interface UpdateSubscriptionStartDateResponse {
+    subscription?: Subscription;
+}
+export interface UpdateSubscriptionPoliciesRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    id?: string;
+    cancellableByCustomer?: boolean | null;
+}
+export interface UpdateSubscriptionPoliciesResponse {
+    /** Updated policies of the subscription */
+    policies?: SubscriptionPolicies;
+}
+export interface UpdateSubscriptionBillingDateRequest {
+    /**
+     * ID of the subscription to update the billing date for.
+     * @format GUID
+     */
+    id: string;
+    /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
+    billingDate: Date | null;
+    /**
+     * Information about how BASS adjusts the total of the next invoice. Extending
+     * the current billing cycle results in a higher payment, while shortening it
+     * leads to a lower payment. BASS offers automatic calculation of the proration
+     * amount based on the number of days added to or removed from the current billing
+     * cycle. Alternatively, you can use your own custom method to calculate the
+     * proration amount. The custom proration amount can't exceed the total of the
+     * current billing cycle.
+     */
+    proration?: Proration;
+}
+export interface UpdateSubscriptionBillingDateResponse {
+    /** Updated subscription. */
+    subscription?: Subscription;
+}
+export interface SubscriptionBillingDateUpdated {
+    subscription?: Subscription;
+    billingDate?: Date | null;
+    proration?: Proration;
+}
+export interface UpdateSubscriptionOriginRequest {
+    /**
+     * ID of the subscription to update origin.
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * Origin entity ID of the subscription to update.
+     * @format GUID
+     */
+    entityId?: string;
+}
+export interface UpdateSubscriptionOriginResponse {
+    /** Updated subscription. */
+    subscription?: Subscription;
+}
+export interface ReviseSubscriptionRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * 0 for no revision, maxSize is 100
+     * @maxSize 100
+     */
+    items?: Item[];
+}
+export interface ReviseSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface UpdateSubscriptionItemsRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    id?: string;
+    /** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
+    updateAction?: UpdateAction;
+    /** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
+    scheduleAdditionalInfo?: ScheduleAdditionalInfo;
+    /**
+     * Existing items to update
+     * @maxSize 100
+     */
+    itemsToUpdate?: ItemChange[];
+    /**
+     * Items to add
+     * @maxSize 99
+     */
+    itemsToAdd?: Item[];
+    /**
+     * Existing items to delete
+     * @format GUID
+     * @maxSize 99
+     */
+    itemsToDelete?: string[] | null;
+}
+export declare enum UpdateAction {
+    NONE = "NONE",
+    /** Update subscription immediately, please note proration for updates changing price are not yet supported */
+    IMMEDIATELY = "IMMEDIATELY",
+    /** Request updates that will take affect only at the start of the next billing cycle. */
+    NEXT_BILLING_CYCLE = "NEXT_BILLING_CYCLE",
+    /** Reset all pending updates */
+    RESET_PENDING_UPDATES = "RESET_PENDING_UPDATES",
+    /** Request updates that will take affect only at a specific date. */
+    SPECIFIC_DATE = "SPECIFIC_DATE"
+}
+export interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
+    /**
+     * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
+     * format. The use of this field may be restricted in various BASS endpoints.
+     * For example, in _Bulk Update Subscription Items_ it's only available in
+     * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
+     * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
+     * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
+     */
+    specificDate?: Date | null;
+    /**
+     * When the update becomes effective, as number of billing cycles from now.
+     * The use of this field may be restricted in various BASS endpoints.
+     * For example, in _Pause Subscription_ it's only available in
+     * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
+     * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
+     * @min 1
+     */
+    numberOfCycles?: number;
+}
+/** @oneof */
+export interface ScheduleAdditionalInfoParamOneOf {
+    /**
+     * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
+     * format. The use of this field may be restricted in various BASS endpoints.
+     * For example, in _Bulk Update Subscription Items_ it's only available in
+     * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
+     * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
+     * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
+     */
+    specificDate?: Date | null;
+    /**
+     * When the update becomes effective, as number of billing cycles from now.
+     * The use of this field may be restricted in various BASS endpoints.
+     * For example, in _Pause Subscription_ it's only available in
+     * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
+     * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
+     * @min 1
+     */
+    numberOfCycles?: number;
+}
+export interface UpdateSubscriptionItemsResponse {
+    subscription?: Subscription;
+}
+export interface BulkUpdateSubscriptionItemsByFilterRequest {
+    /**
+     * Filter to identify the subscriptions for which items are updated. For
+     * supported fields see
+     * [Search and Query: Bulk Update Subscription Items By Filter](https://bo.wix.com/wix-docs/rest/drafts/subscriptions-by-billing-by-wix/search-and-query#drafts_subscriptions-by-billing-by-wix_search-and-query_bulk-update-subscription-items-by-filter).
+     * Sending an empty subscription filter results in a validation error.
+     * In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
+     * `subscriptionId` field inside this filter. Passing any other filter results
+     * in a failed validation error.
+     */
+    subscriptionFilter?: Record<string, any> | null;
+    /**
+     * Filter to specify which subscription items are updated. Make sure to use
+     * the catalog item ID and not the item's unique ID. All subscription items
+     * with matching `items.catalogReference.catalogItemId` are updated.
+     *
+     * Max: `100` reference catalog item IDs
+     * @format GUID
+     * @maxSize 100
+     */
+    catalogReferenceIds?: string[] | null;
+    /**
+     * Information about the update timing and update type.
+     *
+     * + `"IMMEDIATELY"`: The updates become effective immediately.
+     * + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
+     * + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
+     * + `"RESET_PENDING_UPDATES"`: All currently scheduled updates for the specified supcriptions are canceled. Use only the `subscriptionId` field inside `subscriptionFilter`, all other filters result in failed validation errors.
+     */
+    updateAction?: UpdateAction;
+    /**
+     * Additional information for updates. Currently, only supported for
+     * `{"updateAction": "SPECIFIC_DATE"}`.
+     */
+    scheduleAdditionalInfo?: ScheduleAdditionalInfo;
+    /**
+     * Update details for the susbcription items that match the filtering.
+     * Currently, you can update only the item price, quantity, and tax. Note
+     * that all item properties are updated to the same values. In case you want set
+     * different values for individual items, you must call
+     * _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
+     */
+    bulkItemUpdateData?: BulkItemChange;
+    /**
+     * __Not implemented yet__. Items to add to the subscriptions matching the filtering.
+     * @maxSize 99
+     */
+    itemsToAdd?: Item[];
+}
+export interface BulkItemChange {
+    /** Information about the new item price. */
+    pricingModel?: PricingModel;
+    /**
+     * New item quantity.
+     *
+     * Min: `1`
+     * @min 1
+     */
+    quantity?: number | null;
+    /** Information about the new item tax. */
+    tax?: Tax;
+}
+export interface BulkUpdateSubscriptionItemsByFilterResponse {
+    /**
+     * ID of your bulk job. You can use
+     * [this Async Infra call](https://pbo.wix.com/fire-console/?artifact=com.wixpress.asyncinfra.async-job-service&service=wix.infra.asyncjobs.v1.AsyncJobService&method=ListAsyncJobItems&body=eyJqb2JfaWQiOiIifQ%3D%3D)
+     * to retrieve information about the job status.
+     */
+    jobId?: string;
+}
+export interface DeleteSubscriptionRequest {
+    /** @format GUID */
+    id?: string;
+    revision?: string;
+}
+export interface DeleteSubscriptionResponse {
+}
+export interface CancelSubscriptionRequest {
+    /** @format GUID */
+    id: string;
+    actionContext: ActionContext;
+}
+export interface ActionContext {
+    initiator?: ActionInitiator;
+    /** Optional action reason message */
+    reason?: string | null;
+}
+export interface CancelSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface PauseSubscriptionRequest {
+    /** @format GUID */
+    id: string;
+    pausePolicy?: PausePolicy;
+    pauseAt?: PauseAt;
+    /** contains additional scheduling information for certain pause_at options (for example: SPECIFIC_DATE & NUMBER_OF_CYCLES_FROM_TODAY) */
+    pauseAtSchedule?: ScheduleAdditionalInfo;
+    /** contains additional scheduling information for certain auto_resume_at either specific date */
+    autoResumeAtSchedule?: ScheduleAdditionalInfo;
+    actionContext: ActionContext;
+}
+export interface PauseSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface SubscriptionPaused {
+    subscription?: Subscription;
+    pausePolicy?: PausePolicy;
+    actionDetails?: ActionDetails;
+}
+export interface PauseSubscriptionRequested {
+    subscription?: Subscription;
+    pauseAt?: PauseAt;
+    pausePolicy?: PausePolicy;
+    actionDetails?: ActionDetails;
+}
+export interface ScheduledPauseCanceled {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+export interface ResumeSubscriptionRequest {
+    /** @format GUID */
+    id: string;
+    resumeAt?: ResumeAt;
+    /** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
+    resumeAtSchedule?: ScheduleAdditionalInfo;
+    actionContext: ActionContext;
+}
+export interface ResumeSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface SubscriptionResumed {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+export interface ResumeSubscriptionRequested {
+    subscription?: Subscription;
+    resumeAt?: ResumeAt;
+    actionDetails?: ActionDetails;
+}
+export interface ScheduledResumeCanceled {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+export interface SearchSubscriptionsRequest extends SearchSubscriptionsRequestPagingMethodOneOf {
+    /** Limit number of results and enable to skip rows. The default limit is 25. */
+    paging?: Paging;
+    /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
+    cursor?: CursorPaging;
+    /** A filter object */
+    filter?: any;
+    /** A Sorting option by field name and order. */
+    sorting?: SortingClauses;
+}
+/** @oneof */
+export interface SearchSubscriptionsRequestPagingMethodOneOf {
+    /** Limit number of results and enable to skip rows. The default limit is 25. */
+    paging?: Paging;
+    /** A Cursor option for efficient paging. Pass this field from the previous search response to continue to the next page. */
+    cursor?: CursorPaging;
+}
+export interface SortingClauses {
+    sorting?: Sorting[];
+}
+export interface SearchSubscriptionsResponse {
+    subscriptions?: Subscription[];
+    cursor?: CursorPaging;
+}
+export interface TurnOnSubscriptionAutoRenewalRequest {
+    /** @format GUID */
+    id: string;
+    actionContext: ActionContext;
+}
+export interface TurnOnSubscriptionAutoRenewalResponse {
+    subscription?: Subscription;
+}
+export interface SubscriptionAutoRenewalTurnedOn {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+export interface TurnOffSubscriptionAutoRenewalRequest {
+    /** @format GUID */
+    id: string;
+    actionContext: ActionContext;
+}
+export interface TurnOffSubscriptionAutoRenewalResponse {
+    subscription?: Subscription;
+}
+export interface SubscriptionAutoRenewalTurnedOff {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+export interface MarkLatestInvoiceAsPaidRequest {
+    /**
+     * The ID of the offline subscription to mark as paid its latest invoice
+     * @format GUID
+     */
+    subscriptionId: string;
+}
+export interface MarkLatestInvoiceAsPaidResponse {
+    subscription?: Subscription;
+}
+export interface LatestInvoiceMarkedAsPaid {
+    subscription?: Subscription;
+}
+export interface MultipleSubscriptionsOnOrdersInvoice {
+    /**
+     * the invoice id of the affected subscription
+     * @format GUID
+     */
+    invoiceId?: string;
+    /**
+     * the order id of the affected subscription
+     * @format GUID
+     */
+    orderId?: string;
+}
+export interface MarkBillingCycleAsPaidRequest {
+    /**
+     * The ID of the subscription to mark as paid its invoice.
+     * @format GUID
+     */
+    subscriptionId: string;
+    /**
+     * The subscription cycle for which the invoice is to be marked as paid.
+     * If left empty, the most recent cycle will be selected.
+     * @min 1
+     */
+    paidCycle?: number | null;
+}
+export interface MarkBillingCycleAsPaidResponse {
+    subscription?: Subscription;
+}
+export interface GetSubscriptionsStatsRequest {
+}
+export interface GetSubscriptionsStatsResponse {
+    amountByStatuses?: AmountByStatus[];
+    total?: number;
+}
+export interface AmountByStatus {
+    status?: SubscriptionStatusEnumSubscriptionStatus;
+    amount?: number;
+}
+export interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
+    /** User won't be charged for additional period added on top of subscription end date. */
+    extensionPeriod?: Duration;
+    /**
+     * user will be charged for billing cycles added
+     * @min 1
+     */
+    extensionBillingCycles?: number;
+    /**
+     * The ID of the subscription to be extended
+     * @format GUID
+     */
+    id: string;
+    actionContext: ActionContext;
+}
+/** @oneof */
+export interface ExtendSubscriptionRequestExtendPolicyOneOf {
+    /** User won't be charged for additional period added on top of subscription end date. */
+    extensionPeriod?: Duration;
+    /**
+     * user will be charged for billing cycles added
+     * @min 1
+     */
+    extensionBillingCycles?: number;
+}
+export interface ExtendSubscriptionResponse {
+    /** The now extended subscription */
+    subscription?: Subscription;
+}
+export interface AllowedActionsRequest {
+    /** @format GUID */
+    id: string;
+    /**
+     * List of additional fields to be included in the response.
+     * @maxSize 1
+     */
+    fields?: RequestedFields[];
+}
+export declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** Include unsupported action list, including the reasons for the lack of support */
+    UNSUPPORTED_ACTION = "UNSUPPORTED_ACTION"
+}
+export interface AllowedActionsResponse {
+    /** List of actions that are allowed. */
+    actions?: Action[];
+    /**
+     * List of actions that are not supported, included only if requested. Provides reasons for each unsupported action.
+     * @maxSize 20
+     */
+    unsupportedActions?: UnsupportedAction[];
+}
+export interface UnsupportedAction {
+    actionType?: ActionType;
+    /**
+     * Provides detailed reasons for the unsupported action. Each `UnsupportedReason` includes a code and a message explaining why the action is not allowed.
+     * @maxSize 20
+     */
+    reasons?: UnsupportedReason[];
+}
+export interface UnsupportedReason {
+    code?: string;
+    description?: string | null;
+}
+export interface ListUpcomingChargesRequest {
+    /**
+     * Subscription id charges to be previewed for
+     * @format GUID
+     */
+    subscriptionId: string;
+    /** Period of time to provide charged for. If not provided,then only next charge will be returned. */
+    customDuration?: Duration;
+    /**
+     * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
+     * If not provided, the upcoming charges will be calculated according to the existing next billing date.
+     */
+    nextBillingDate?: Date | null;
+}
+export interface ListUpcomingChargesResponse {
+    upcomingCharges?: SubscriptionCharge[];
+}
+export interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
+    /** Information about a non-existing subscription. */
+    subscriptionInfo?: SubscriptionInfo;
+}
+/** @oneof */
+export interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
+    /** Information about a non-existing subscription. */
+    subscriptionInfo?: SubscriptionInfo;
+}
+/** Subscription information to use for calculating the preview of charges for a subscription. */
+export interface SubscriptionInfo {
+    billingSettings?: BillingSettings;
+    items?: Item[];
+    startDate?: Date | null;
+}
+export interface PreviewSubscriptionChargesResponse {
+    /** Charges for subscription. */
+    charges?: Charge[];
+}
+/** Represents a charge applicable to a subscription. */
+export interface Charge {
     /** The cycle number from which the charge starts. */
     cycleFrom?: number;
     /** The number of cycles for which the charge is applicable. */
@@ -2163,7 +2701,11 @@ export interface Charge {
     cycleBillingDate?: Date | null;
 }
 export interface PreviewSubscriptionsChargesRequest {
-    /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
+    /**
+     * Information required to calculate the preview charges for the subscriptions, including an identifier.
+     * @minSize 1
+     * @maxSize 10
+     */
     subscriptionsBillingDetails?: SubscriptionBillingDetails[];
     /**
      * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
@@ -2176,15 +2718,24 @@ export interface PreviewSubscriptionsChargesRequest {
      * in this case, charges for cycle 1 through 3.
      * If there is a single charge for a subscription, meaning that subscription price remains consistent across all cycles,
      * then even if future_charges_count is set, it will be ignored and the only charge this subscription has will be returned.
+     * @min 1
+     * @max 10
      */
     numberOfNextRecurringCharges?: number | null;
 }
 export interface SubscriptionBillingDetails {
-    /** External identifier of the subscription */
+    /**
+     * External identifier of the subscription
+     * @format GUID
+     */
     externalId?: string | null;
     /** Billing details parameters including schedule, currency, etc. */
     billingSettings?: BillingSettings;
-    /** Items, minSize is 1, maxSize is 100 */
+    /**
+     * Items, minSize is 1, maxSize is 100
+     * @minSize 1
+     * @maxSize 100
+     */
     items?: Item[];
     /** Subscription start date, now if not set */
     startDate?: Date | null;
@@ -2196,7 +2747,10 @@ export interface PreviewSubscriptionsChargesResponse {
     subscriptionsCharges?: SubscriptionCharges[];
 }
 export interface SubscriptionCharges {
-    /** External identifier of the subscription */
+    /**
+     * External identifier of the subscription
+     * @format GUID
+     */
     externalId?: string | null;
     /** Charges for subscription. */
     charges?: Charge[];
@@ -2204,7 +2758,10 @@ export interface SubscriptionCharges {
 export interface CreateSubscriptionForOrderRequest {
     /** Subscription needs to be created */
     subscription?: Subscription;
-    /** Optional unique identifier for this request in order to prevent subscription duplications */
+    /**
+     * Optional unique identifier for this request in order to prevent subscription duplications
+     * @format GUID
+     */
     idempotencyKey?: string | null;
 }
 export interface CreateSubscriptionForOrderResponse {
@@ -2217,6 +2774,7 @@ export interface CreateSubscriptionForOrderResponse {
 export interface Invoice {
     /**
      * Invoice ID.
+     * @format GUID
      * @readonly
      */
     id?: string | null;
@@ -2256,6 +2814,7 @@ export interface Invoice {
     /**
      * 3-letter currency code of the invoice in
      * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
      */
     currency?: string;
     /** Information about the customer. */
@@ -2274,11 +2833,13 @@ export interface Invoice {
      * [payment method](https://bo.wix.com/wix-docs/rest/wix-cashier/settings/payment-method-type/payment-method-type-object).
      * Not available for the first payment of a subscription and all offline
      * payments.
+     * @format GUID
      */
     paymentMethodId?: string | null;
     /**
      * Cashier [Order ID](https://dev.wix.com/docs/rest/payments/wix-cashier/pay/order#order-object)
      * for the corresponding payment.
+     * @format GUID
      * @readonly
      */
     paymentOrderId?: string | null;
@@ -2288,7 +2849,10 @@ export interface Invoice {
     billingAddress?: FullAddressDetails;
     /** Shipping address. Available only for `"PHYSICAL"` line items. */
     shippingAddress?: FullAddressDetails;
-    /** Shipping fee in `0.00` format. */
+    /**
+     * Shipping fee in `0.00` format.
+     * @format DECIMAL_VALUE
+     */
     shippingFee?: string | null;
     /**
      * Information about the invoice's totals.
@@ -2312,6 +2876,7 @@ export interface Invoice {
     adjustments?: PriceAdjustment[];
     /**
      * Invoice Number.
+     * @maxLength 10
      * @readonly
      */
     invoiceNumber?: string | null;
@@ -2325,23 +2890,29 @@ export interface Invoice {
     taxData?: TaxData;
     /** Business address. */
     businessAddress?: Address;
-    /** ID of the billing order that created this invoice. */
+    /**
+     * ID of the billing order that created this invoice.
+     * @format GUID
+     */
     orderId?: string | null;
 }
 export interface BusinessOriginData {
     /**
      * ID of the app for which BASS has created the invoice. For example,
      * `"1380b703-ce81-ff05-f115-39571d94dfcd"` for the Wix eCommerce app.
+     * @format GUID
      */
     appId?: string;
     /**
      * [Instance ID](https://dev.wix.com/api/rest/app-management/apps/app-instance/get-app-instance)
      * of the app for which BASS has created the invoice.
+     * @format GUID
      */
     instanceId?: string;
     /**
      * ID of the entity that triggered the invoice creation. For example, the ID of a
      * [pricing plan](https://dev.wix.com/docs/rest/payments/pricing-plans/pricing-plans/plan#plan-object).
+     * @format GUID
      */
     entityId?: string;
 }
@@ -2367,6 +2938,7 @@ export declare enum CreationMode {
 export interface LatestPaymentAttempt {
     /**
      * ID of the latest payment attempt.
+     * @format GUID
      * @readonly
      */
     paymentAttemptId?: string;
@@ -2424,6 +2996,7 @@ export interface PriceAdjustmentValue extends PriceAdjustmentValueAdjustmentValu
      * Absolute amount that adjusts the price.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -2435,6 +3008,7 @@ export interface PriceAdjustmentValue extends PriceAdjustmentValueAdjustmentValu
      *
      * Min: `0.01`
      * Max: `1.00`
+     * @decimalValue options { gt:0.00, lte:1 }
      */
     multiplier?: string;
 }
@@ -2444,6 +3018,7 @@ export interface PriceAdjustmentValueAdjustmentValueTypeOneOf {
      * Absolute amount that adjusts the price.
      *
      * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
      */
     amount?: string;
     /**
@@ -2455,6 +3030,7 @@ export interface PriceAdjustmentValueAdjustmentValueTypeOneOf {
      *
      * Min: `0.01`
      * Max: `1.00`
+     * @decimalValue options { gt:0.00, lte:1 }
      */
     multiplier?: string;
 }
@@ -2463,6 +3039,7 @@ export interface InvoiceShippingCharges {
      * Amount of the shipping fee in `0.00` format.
      *
      * Min: `0.01`
+     * @decimalValue options { gte:0.00, maxScale:2 }
      */
     amount?: string;
     /** Tax of the shipping fee */
@@ -2477,23 +3054,45 @@ export interface TaxData {
     taxSummary?: TaxSummary;
 }
 export interface TaxSummary {
-    /** Aggregated from tax_breakdowns with exemptions excluded from amount */
+    /**
+     * Aggregated from tax_breakdowns with exemptions excluded from amount
+     * @format DECIMAL_VALUE
+     */
     aggregatedTaxAmount?: string;
-    /** Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`. */
+    /**
+     * Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`.
+     * @maxSize 50
+     */
     aggregatedTaxBreakdowns?: AggregatedTaxBreakdown[];
 }
 export interface AggregatedTaxBreakdown {
-    /** Name of the tax that was calculated. */
+    /**
+     * Name of the tax that was calculated.
+     * @maxLength 200
+     */
     taxName?: string;
-    /** Type of tax that was calculated. */
+    /**
+     * Type of tax that was calculated.
+     * @maxLength 200
+     */
     taxType?: string;
-    /** Jurisdiction that taxes were calculated for. */
+    /**
+     * Jurisdiction that taxes were calculated for.
+     * @maxLength 200
+     */
     jurisdiction?: string;
     /** Type of jurisdiction that taxes were calculated for. */
     jurisdictionType?: string;
-    /** Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`. */
+    /**
+     * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`.
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
     rate?: string;
-    /** Total amount of this tax for this jurisdiction. */
+    /**
+     * Total amount of this tax for this jurisdiction.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
     aggregatedTaxAmount?: string;
 }
 export interface Task {
@@ -2525,8 +3124,6 @@ export interface Reschedule {
     executeAt?: Date | null;
     payload?: string | null;
 }
-export interface Empty {
-}
 export interface V1SubscriptionEvent extends V1SubscriptionEventEventOneOf {
     /** A subscriptions was created */
     created?: V1SubscriptionCreated;
@@ -2594,22 +3191,41 @@ export interface V1SubscriptionCreated {
 export interface V1Subscription {
     /**
      * ID of the subscription
+     * @format GUID
      * @readonly
      */
     id?: string;
-    /** ID of the app which created the subscription */
+    /**
+     * ID of the app which created the subscription
+     * @format GUID
+     */
     wixAppId?: string;
-    /** Instance ID of the Subscriptions app */
+    /**
+     * Instance ID of the Subscriptions app
+     * @format GUID
+     */
     tenantId?: string;
-    /** ID of entity in app (e.g. a cart in stores/order in paid plans) */
+    /**
+     * ID of entity in app (e.g. a cart in stores/order in paid plans)
+     * @format GUID
+     */
     originEntityId?: string;
     /** Site member or a contact who bought the subscription */
     subscriber?: Subscriber;
-    /** Wix Pay order ID, is empty for free subscriptions */
+    /**
+     * Wix Pay order ID, is empty for free subscriptions
+     * @format GUID
+     */
     wixPayOrderId?: string | null;
-    /** Subscription name (e.g. a product or subscription package name) */
+    /**
+     * Subscription name (e.g. a product or subscription package name)
+     * @maxLength 150
+     */
     name?: string;
-    /** Optional additional subscription description */
+    /**
+     * Optional additional subscription description
+     * @maxLength 500
+     */
     description?: string;
     /** Amount to be paid for a single scheduled payment */
     price?: Money;
@@ -2643,10 +3259,14 @@ export interface V1Subscription {
     validUntilDateWithSuspensions?: Date | null;
     /** Duration of single payment subscription (instead of billing_profile) */
     singlePaymentDuration?: V1Duration;
+    /** @format GUID */
     originInstanceId?: string | null;
 }
 export interface Subscriber {
-    /** Member or contact ID */
+    /**
+     * Member or contact ID
+     * @format GUID
+     */
     id?: string;
     /** Member or contact */
     identityType?: IdentityType;
@@ -2661,9 +3281,16 @@ export declare enum IdentityType {
 }
 /** Price of a payment. Includes amount and currency. */
 export interface Money {
-    /** Monetary amount i.e. 3.99. */
+    /**
+     * Monetary amount i.e. 3.99.
+     * @format DECIMAL_VALUE
+     */
     amount?: string;
-    /** Currency in ISO 4217 format i.e. USD. */
+    /**
+     * Currency in ISO 4217 format i.e. USD.
+     * @minLength 3
+     * @maxLength 3
+     */
     currency?: string;
 }
 export declare enum SubscriptionType {
@@ -2745,358 +3372,262 @@ export declare enum SubscriptionFrequency {
 export interface SubscriptionTrialPeriod {
     /** trial period in units (required) */
     period?: number;
-    /** units in which trial period is described (optional, default DAY) */
-    unit?: SubscriptionFrequency;
-}
-export declare enum CancellationInitiator {
-    /** Cancellation initiator undefined */
-    UNDEFINED = "UNDEFINED",
-    /** Subscription was canceled by site owner (default if canceled by user or service identity) */
-    OWNER = "OWNER",
-    /** Subscription was canceled by member (default if canceled by member identity) */
-    MEMBER = "MEMBER",
-    /** Subscription was canceled because of payment failure */
-    PAYMENT_FAILURE = "PAYMENT_FAILURE",
-    /** Subscription was canceled because of payment setup failure */
-    SETUP_FAILURE = "SETUP_FAILURE"
-}
-export interface SubscriptionPolicy {
-    /** Subscription expiration date can be updated */
-    expiryDateChangeable?: boolean;
-    /** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
-    cancellableByMember?: boolean;
-    /** Subscription expiration date on cancellation can be set to next payment date */
-    cancellableAtNextPaymentCycle?: boolean;
-}
-export interface Suspension {
-    status?: Status;
-    /** Beginning of the suspended period */
-    startsAt?: Date | null;
-    /** End of the suspended period */
-    endsAt?: Date | null;
-}
-export declare enum Status {
-    UNDEFINED = "UNDEFINED",
-    ACTIVE = "ACTIVE",
-    ENDED = "ENDED"
-}
-/** A duration expressed in amount of time units. */
-export interface V1Duration {
-    /** Amount of the unit */
-    amount?: number;
-    /** Day, Week, Month, Year. */
-    unit?: SubscriptionFrequency;
-}
-export interface V1SubscriptionActivated {
-    subscription?: V1Subscription;
-}
-export interface V1SubscriptionCanceled {
-    subscription?: V1Subscription;
-}
-export interface V1SubscriptionUpdated {
-    subscription?: V1Subscription;
-}
-export interface SubscriptionCycleTriggered {
-    subscription?: V1Subscription;
-    billingCycle?: number;
-    /** Wix Pay transaction id, optional. Exists if event was triggered by a payment. */
-    transactionId?: string | null;
-}
-export interface SubscriptionMarkedAsPaid {
-    subscription?: V1Subscription;
-    /** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
-    billingCycle?: number | null;
-}
-export interface SubscriptionCancellationRequested {
-    subscription?: V1Subscription;
-}
-export interface SubscriptionSuspended {
-    subscription?: V1Subscription;
-}
-export interface V1SubscriptionResumed {
-    subscription?: V1Subscription;
-}
-export interface SubscriptionExpired {
-    subscription?: V1Subscription;
-}
-export interface V1SubscriptionInitialPurchaseCompleted {
-    subscription?: V1Subscription;
-}
-export interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
-    activeSubscription?: CreateSubscriptionRequest;
-}
-/** @oneof */
-export interface CreateSubscriptionInStateRequestModeOneOf {
-    activeSubscription?: CreateSubscriptionRequest;
-}
-export interface CreateSubscriptionInStateResponse {
-    subscriptionId?: string;
-}
-export interface PayCycleRequest {
-    subscriptionId: string;
-    paymentTestMode?: PaymentTestMode;
-    tenantId: string;
-}
-export declare enum PaymentTestMode {
-    REGULAR = "REGULAR",
-    FAIL_TECHNICAL = "FAIL_TECHNICAL",
-    FAIL_DECLINE = "FAIL_DECLINE",
-    FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
-}
-export interface PayCycleResponse {
-    invoiceId?: string;
-    paymentOrderId?: string | null;
-    subscription?: Subscription;
-}
-export interface GetFullSubscriptionDataRequest {
-    id?: string;
-}
-export interface GetFullSubscriptionDataResponse {
-    subscription?: Subscription;
-    internalSubscriptionData?: InternalSubscriptionData;
-}
-export interface InternalSubscriptionData {
-    originInstanceId?: string;
-    source?: string | null;
-    billingType?: string;
-    isOneTime?: boolean;
-    migrationDetails?: MigrationDetails;
-    pausePaidDuration?: string | null;
-    authorizationPaymentData?: PaymentData;
-    currentCyclePausePeriods?: PausePeriod[];
-}
-export interface MigrationDetails {
-    /** system (application) where the Subscription has been created */
-    originSystem?: string;
-    /** date when the Subscription started to be managed in BASS */
-    shiftManagementDate?: Date | null;
-}
-export interface PausePeriod {
-    startDate?: Date | null;
-    endDate?: Date | null;
-}
-export interface GetSubscriptionAndInternalDataRequest {
-    subscriptionId?: string;
-    tenantId?: string;
-}
-export interface GetSubscriptionAndInternalDataResponse {
-    subscription?: Subscription;
-    internalSubscriptionData?: InternalSubscriptionData;
-}
-export interface SearchSubscriptionRequest {
-    id?: string;
-    tenantId?: string;
-}
-export interface SearchSubscriptionResponse {
-    subscription?: Subscription;
-}
-export interface UpdatePausePaidDurationRequest {
-    subscriptionId?: string;
-    pausePaidDurationSeconds?: string;
-    tenantId?: string;
-}
-export interface UpdatePausePaidDurationResponse {
-}
-export interface UpdateStatusRequest {
-    subscriptionId?: string;
-    tenantId?: string;
-    status?: SubscriptionStatusEnumSubscriptionStatus;
-}
-export interface UpdateStatusResponse {
-    subscription?: Subscription;
-}
-export interface UpdatePaymentStatusRequest {
-    subscriptionId?: string;
-    tenantId?: string;
-    paymentStatus?: PaymentStatus;
-}
-export interface UpdatePaymentStatusResponse {
-    subscription?: Subscription;
-}
-export interface ReviveSubscriptionRequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    revivePolicy?: RevivePolicy;
-    isTestRun?: boolean;
-}
-export declare enum RevivePolicy {
-    SIMPLE = "SIMPLE",
-    RESUME = "RESUME"
-}
-export interface ReviveSubscriptionResponse {
-    subscription?: Subscription;
-}
-export interface ConvertSapiRequest {
-    subscriptionId?: string;
-}
-export interface ConvertSapiResponse {
-    subscription?: Subscription;
+    /** units in which trial period is described (optional, default DAY) */
+    unit?: SubscriptionFrequency;
 }
-export interface GetSubscriptionInvoicesRequest {
-    id?: string;
+export declare enum CancellationInitiator {
+    /** Cancellation initiator undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Subscription was canceled by site owner (default if canceled by user or service identity) */
+    OWNER = "OWNER",
+    /** Subscription was canceled by member (default if canceled by member identity) */
+    MEMBER = "MEMBER",
+    /** Subscription was canceled because of payment failure */
+    PAYMENT_FAILURE = "PAYMENT_FAILURE",
+    /** Subscription was canceled because of payment setup failure */
+    SETUP_FAILURE = "SETUP_FAILURE"
 }
-export interface GetSubscriptionInvoicesResponse {
-    invoices?: SubscriptionInvoice[];
+export interface SubscriptionPolicy {
+    /** Subscription expiration date can be updated */
+    expiryDateChangeable?: boolean;
+    /** Subscription can be cancelled by the member who bought it (when memberId == subscriberId) */
+    cancellableByMember?: boolean;
+    /** Subscription expiration date on cancellation can be set to next payment date */
+    cancellableAtNextPaymentCycle?: boolean;
 }
-export interface SubscriptionInvoice {
-    id?: string;
-    subscriptionCycle?: number;
-    createdDate?: Date | null;
+export interface Suspension {
+    status?: Status;
+    /** Beginning of the suspended period */
+    startsAt?: Date | null;
+    /** End of the suspended period */
+    endsAt?: Date | null;
 }
-export interface FinishFreeTrialNowRequest {
-    subscriptionId?: string;
-    tenantId?: string;
+export declare enum Status {
+    UNDEFINED = "UNDEFINED",
+    ACTIVE = "ACTIVE",
+    ENDED = "ENDED"
 }
-export interface FinishFreeTrialNowResponse {
-    subscription?: Subscription;
+/** A duration expressed in amount of time units. */
+export interface V1Duration {
+    /** Amount of the unit */
+    amount?: number;
+    /** Day, Week, Month, Year. */
+    unit?: SubscriptionFrequency;
 }
-export interface SendTimeCapsuleTaskCanceledBIRequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    taskType?: string;
+export interface V1SubscriptionActivated {
+    subscription?: V1Subscription;
 }
-export interface ScheduleTimeCapsuleTaskRequest {
-    subscriptionId?: string;
-    taskType?: string;
-    executionTime?: Date | null;
-    tenantId?: string;
+export interface V1SubscriptionCanceled {
+    subscription?: V1Subscription;
 }
-export interface CancelTimeCapsuleTaskRequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    taskType?: string;
+export interface V1SubscriptionUpdated {
+    subscription?: V1Subscription;
 }
-export interface UpdateFullSubscriptionRequest {
-    tenantId?: string;
-    subscription?: Subscription;
+export interface SubscriptionCycleTriggered {
+    subscription?: V1Subscription;
+    billingCycle?: number;
+    /**
+     * Wix Pay transaction id, optional. Exists if event was triggered by a payment.
+     * @format GUID
+     */
+    transactionId?: string | null;
 }
-export interface UpdateFullSubscriptionResponse {
-    subscription?: Subscription;
+export interface SubscriptionMarkedAsPaid {
+    subscription?: V1Subscription;
+    /** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
+    billingCycle?: number | null;
 }
-export interface UpdateSubscriptionInvoiceCycleRequest {
-    subscriptionId?: string;
-    tenantId?: string;
-    invoiceId?: string;
-    subscriptionCycle?: number;
+export interface SubscriptionCancellationRequested {
+    subscription?: V1Subscription;
 }
-export interface UpdateSubscriptionInvoiceCycleResponse {
-    subscriptionInvoice?: SubscriptionInvoice;
+export interface SubscriptionSuspended {
+    subscription?: V1Subscription;
 }
-export interface AddPausePeriodRequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    pauseStartDate?: Date | null;
-    pauseEndDate?: Date | null;
+export interface V1SubscriptionResumed {
+    subscription?: V1Subscription;
 }
-export interface AddPausePeriodResponse {
-    subscription?: Subscription;
+export interface SubscriptionExpired {
+    subscription?: V1Subscription;
 }
-export interface RunTimeCapsuleTaskNowRequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    taskType?: string;
+export interface V1SubscriptionInitialPurchaseCompleted {
+    subscription?: V1Subscription;
 }
-export interface CreateRecurringInvoiceBORequest {
-    subscriptionId?: string;
-    tenantId?: string;
-    cycleNumber?: number;
+export interface ListSubscriptionHistoryRequest {
+    /** @format GUID */
+    subscriptionId: string;
+    /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
+    mode?: HistoryViewMode;
+    /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
+    cursor?: CursorPaging;
 }
-export interface CreateRecurringInvoiceBOResponse {
-    invoiceId?: string;
+export declare enum HistoryViewMode {
+    UNKNOWN = "UNKNOWN",
+    /** Comprehensive view including all history events. */
+    BACKOFFICE = "BACKOFFICE",
+    /** User-centric view of the history. */
+    USER = "USER"
 }
-export interface SetShiftingDataRequest {
-    subscriptionId?: string;
-    tenantId?: string;
-    isBassManaged?: boolean;
-    shiftManagementDate?: Date | null;
+export interface ListSubscriptionHistoryResponse {
+    /** List of history entries for the subscription. */
+    historyEntries?: SubscriptionHistoryEntry[];
+    /** Paging metadata. A `next` cursor is returned if there are more results. */
+    pagingMetadata?: PagingMetadataV2;
 }
-export interface SetShiftingDataResponse {
-    subscription?: Subscription;
+export interface SubscriptionHistoryEntry {
+    /** @format GUID */
+    entryId?: string;
+    /** TODO: add max length? it is not defined in domainevents, so should we? */
+    slug?: string;
+    entryTime?: Date | null;
+    event?: SubscriptionEvent;
 }
-export interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
-    attachInvoice?: AttachInvoice;
-    detachInvoice?: DetachInvoice;
-    tenantId?: string;
-    subscriptionId?: string;
+export interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
+    created?: SubscriptionCreated;
+    updated?: SubscriptionUpdated;
+    deleted?: SubscriptionDeleted;
+    activated?: SubscriptionActivated;
+    ended?: SubscriptionEnded;
+    canceled?: SubscriptionCanceled;
+    paused?: SubscriptionPaused;
+    resumed?: SubscriptionResumed;
+    pauseRequested?: PauseSubscriptionRequested;
+    resumeRequested?: ResumeSubscriptionRequested;
+    scheduledPauseCanceled?: ScheduledPauseCanceled;
+    scheduledResumeCanceled?: ScheduledResumeCanceled;
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+    autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
+    autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
+    cycleReadyToPay?: SubscriptionCycleReadyToPay;
+    extended?: SubscriptionExtended;
+    initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
+    latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
+    revived?: SubscriptionRevived;
+    billingDateUpdated?: SubscriptionBillingDateUpdated;
+    futureUpdatesRequested?: FutureUpdatesRequested;
+    updatesApplied?: UpdatesApplied;
+    resetPendingUpdates?: ResetPendingUpdates;
+    gracePeriodStarted?: GracePeriodStarted;
+    gracePeriodEnded?: GracePeriodEnded;
+    paymentMethodUpdated?: PaymentMethodUpdated;
+    collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
+    freeTrailStarted?: FreeTrailStarted;
+    freeTrailEnded?: FreeTrailEnded;
+    billingCyclePaid?: SubscriptionBillingCyclePaid;
+    initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
+    subscriptionBoAction?: SubscriptionBackOfficeAction;
+    unknown?: UnknownSubscriptionEvent;
 }
 /** @oneof */
-export interface FixSubscriptionInvoicesRequestModeOneOf {
-    attachInvoice?: AttachInvoice;
-    detachInvoice?: DetachInvoice;
+export interface SubscriptionEventPayloadOneOf {
+    created?: SubscriptionCreated;
+    updated?: SubscriptionUpdated;
+    deleted?: SubscriptionDeleted;
+    activated?: SubscriptionActivated;
+    ended?: SubscriptionEnded;
+    canceled?: SubscriptionCanceled;
+    paused?: SubscriptionPaused;
+    resumed?: SubscriptionResumed;
+    pauseRequested?: PauseSubscriptionRequested;
+    resumeRequested?: ResumeSubscriptionRequested;
+    scheduledPauseCanceled?: ScheduledPauseCanceled;
+    scheduledResumeCanceled?: ScheduledResumeCanceled;
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+    autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
+    autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
+    cycleReadyToPay?: SubscriptionCycleReadyToPay;
+    extended?: SubscriptionExtended;
+    initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
+    latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
+    revived?: SubscriptionRevived;
+    billingDateUpdated?: SubscriptionBillingDateUpdated;
+    futureUpdatesRequested?: FutureUpdatesRequested;
+    updatesApplied?: UpdatesApplied;
+    resetPendingUpdates?: ResetPendingUpdates;
+    gracePeriodStarted?: GracePeriodStarted;
+    gracePeriodEnded?: GracePeriodEnded;
+    paymentMethodUpdated?: PaymentMethodUpdated;
+    collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
+    freeTrailStarted?: FreeTrailStarted;
+    freeTrailEnded?: FreeTrailEnded;
+    billingCyclePaid?: SubscriptionBillingCyclePaid;
+    initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
+    subscriptionBoAction?: SubscriptionBackOfficeAction;
+    unknown?: UnknownSubscriptionEvent;
 }
-export interface AttachInvoice {
-    invoiceId?: string;
+export interface SubscriptionCreated {
+    subscription?: Subscription;
 }
-export interface DetachInvoice {
-    invoiceId?: string;
+export interface SubscriptionUpdated {
+    current?: Subscription;
+    previous?: Subscription;
+    diff?: SubscriptionDiff;
 }
-export interface FixSubscriptionInvoicesResponse {
-    invoices?: SubscriptionInvoice[];
+export interface SubscriptionDiff {
+    added?: string | null;
+    changed?: string | null;
+    deleted?: string | null;
 }
-export interface RestoreDraftSubscriptionRequest {
-    tenantId?: string;
+export interface SubscriptionDeleted {
     subscriptionId?: string;
 }
-export interface RestoreDraftSubscriptionResponse {
+export interface FutureUpdatesRequested {
     subscription?: Subscription;
+    requestedUpdateData?: SubscriptionUpdateData;
 }
-export interface DeleteDraftSubscriptionRequest {
-    tenantId?: string;
-    subscriptionId?: string;
-}
-export interface DeleteDraftSubscriptionResponse {
+export interface UpdatesApplied {
     subscription?: Subscription;
+    updateAction?: UpdateAction;
+    appliedUpdateData?: SubscriptionUpdateData;
 }
-export interface DeleteSubscriptionBORequest {
-    tenantId?: string;
-    subscriptionId?: string;
-}
-export interface DeleteSubscriptionBOResponse {
+export interface ResetPendingUpdates {
     subscription?: Subscription;
 }
-export interface CancelSubscriptionBORequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    initiator?: ActionInitiator;
-    reason?: string | null;
+export interface GracePeriodStarted {
+    subscription?: Subscription;
 }
-export interface CancelSubscriptionBOResponse {
+export interface GracePeriodEnded {
     subscription?: Subscription;
+    /** Indication for the payment settlement method. */
+    paymentSettlementMethod?: PaymentSettlementMethod;
 }
-export interface UpdatePaymentMethodBORequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    paymentMethodId?: string;
+export declare enum PaymentSettlementMethod {
+    UNKNOWN = "UNKNOWN",
+    /** System-defined payment settlement. */
+    SYSTEM = "SYSTEM",
+    /** Manually mark the payment as paid. */
+    MARK_AS_PAID = "MARK_AS_PAID",
+    /** Require the customer to pay immediately, by insert a new payment method. */
+    CUSTOMER_PAY_NOW = "CUSTOMER_PAY_NOW"
 }
-export interface UpdatePaymentMethodBOResponse {
+export interface PaymentMethodUpdated {
     subscription?: Subscription;
+    initiator?: HistoryActionInitiator;
+    paymentMode?: PaymentMode;
 }
-export interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
-    billingCycleStarted?: SubscriptionBillingCycleStarted;
-    tenantId?: string;
-    subscriptionId?: string;
-}
-/** @oneof */
-export interface SendSubscriptionActionEventBORequestEventOneOf {
-    billingCycleStarted?: SubscriptionBillingCycleStarted;
+export interface SubscriptionCollectionMethodUpdated {
+    subscription?: Subscription;
+    newCollectionMethod?: CollectionMethodEnumCollectionMethod;
+    previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
 }
-export interface SendSubscriptionActionEventResponse {
+export interface FreeTrailStarted {
+    subscription?: Subscription;
 }
-export interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    transactionId?: string;
+export interface FreeTrailEnded {
+    subscription?: Subscription;
 }
-export interface PauseSubscriptionBORequest {
-    tenantId?: string;
-    subscriptionId?: string;
-    pausePolicy?: PausePolicy;
-    pauseAt?: PauseAt;
-    initiator?: ActionInitiator;
-    reason?: string | null;
+export interface InitiatedPaymentMethodSetup {
+    subscription?: Subscription;
 }
-export interface PauseSubscriptionBOResponse {
+export interface SubscriptionBackOfficeAction {
     subscription?: Subscription;
+    /** The backoffice method name */
+    name?: string;
+    /** json as string format, to store the flatted request object */
+    params?: string;
+}
+/** Defines unknown events restored from the logs */
+export interface UnknownSubscriptionEvent {
+    subscriptionAsString?: string | null;
 }
 interface CustomerNonNullableFields {
     visitorId: string;
@@ -3203,78 +3734,241 @@ interface UpdateBillingDateDataNonNullableFields {
 interface AutomaticRetryDataNonNullableFields {
     enabled: boolean;
 }
-interface GracePeriodDataNonNullableFields {
-    automaticRetryData?: AutomaticRetryDataNonNullableFields;
+interface GracePeriodDataNonNullableFields {
+    automaticRetryData?: AutomaticRetryDataNonNullableFields;
+}
+interface BillingStatusNonNullableFields {
+    currentCycle: number;
+    latestPaymentData?: PaymentDataNonNullableFields;
+    updateBillingDateData?: UpdateBillingDateDataNonNullableFields;
+    gracePeriodData?: GracePeriodDataNonNullableFields;
+}
+interface SubscriptionPoliciesNonNullableFields {
+    customerCanCancel: boolean;
+    businessCanExtend: boolean;
+    allowEndOfCycleCancellation: boolean;
+}
+interface PauseInfoNonNullableFields {
+    pausePolicy: PausePolicy;
+    pauseAt: PauseAt;
+    resumeAt: ResumeAt;
+}
+interface CancellationInfoNonNullableFields {
+    initiator: HistoryActionInitiator;
+}
+interface FixedPriceNonNullableFields {
+    itemPrice: string;
+}
+interface PricingModelNonNullableFields {
+    fixedPrice?: FixedPriceNonNullableFields;
+}
+interface ItemChangeNonNullableFields {
+    id: string;
+    pricingModel?: PricingModelNonNullableFields;
+    tax?: TaxNonNullableFields;
+}
+interface CatalogReferenceNonNullableFields {
+    catalogItemId: string;
+}
+interface ApplicationFeeNonNullableFields {
+    amount: string;
+    discounts: DiscountNonNullableFields[];
+}
+interface ItemNonNullableFields {
+    name: string;
+    catalogReference?: CatalogReferenceNonNullableFields;
+    category: ItemCategory;
+    quantity: number;
+    pricingModel?: PricingModelNonNullableFields;
+    tax?: TaxNonNullableFields;
+    discounts: DiscountNonNullableFields[];
+    applicationFee?: ApplicationFeeNonNullableFields;
+}
+interface SubscriptionUpdateDataNonNullableFields {
+    itemsToUpdate: ItemChangeNonNullableFields[];
+    itemsToAdd: ItemNonNullableFields[];
+    numberOfRequests: number;
+}
+interface SpecificDateSubscriptionUpdateDataNonNullableFields {
+    updateData?: SubscriptionUpdateDataNonNullableFields;
+}
+interface SubscriptionNonNullableFields {
+    name: string;
+    customer?: CustomerNonNullableFields;
+    status: SubscriptionStatusEnumSubscriptionStatus;
+    billingSettings?: BillingSettingsNonNullableFields;
+    billingStatus?: BillingStatusNonNullableFields;
+    shippingAddress?: FullAddressDetailsNonNullableFields;
+    policies?: SubscriptionPoliciesNonNullableFields;
+    pauseInfo?: PauseInfoNonNullableFields;
+    cancellationInfo?: CancellationInfoNonNullableFields;
+    pendingUpdateData?: SubscriptionUpdateDataNonNullableFields;
+    bassManaged: boolean;
+    specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
+    items: ItemNonNullableFields[];
+}
+export interface GetSubscriptionResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface CustomerCancelSubscriptionResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface CustomerTurnOnAutoRenewalResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface CustomerTurnOffAutoRenewalResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface CustomerExtendSubscriptionResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface QuerySubscriptionsResponseNonNullableFields {
+    subscriptions: SubscriptionNonNullableFields[];
+}
+export interface UpdateSubscriptionPaymentMethodResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface ActionNonNullableFields {
+    actionType: ActionType;
+    pausePolicies: PausePolicy[];
+    pauseAt: PauseAt[];
+    resumeAt: ResumeAt[];
+    extendPolicies: ExtendPolicyType[];
+}
+export interface CustomerAllowedActionsResponseNonNullableFields {
+    actions: ActionNonNullableFields[];
+}
+interface RecurringNonNullableFields {
+    cycleNumber: number;
+}
+interface InvoiceDiscountNonNullableFields {
+    amount: string;
+    percentage: string;
+    origin?: DiscountOriginNonNullableFields;
+}
+interface InvoiceApplicationFeeNonNullableFields {
+    amount: string;
+    discount?: InvoiceDiscountNonNullableFields;
+}
+interface PriceDetailsNonNullableFields {
+    price: string;
+    tax?: TaxNonNullableFields;
+    discount?: InvoiceDiscountNonNullableFields;
+    applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
+}
+interface LineItemTaxSummaryNonNullableFields {
+    aggregatedTaxAmount: string;
+    aggregatedTaxRate: string;
+    taxableAmount: string;
+}
+interface TaxBreakdownNonNullableFields {
+    taxType: string;
+    taxRate: string;
+    jurisdictionType: string;
+}
+interface ItemTaxDataNonNullableFields {
+    lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields;
+    taxBreakdowns: TaxBreakdownNonNullableFields[];
+}
+interface InvoiceItemNonNullableFields {
+    recurring?: RecurringNonNullableFields;
+    id: string;
+    name: string;
+    catalogReference?: CatalogReferenceNonNullableFields;
+    category: ItemCategory;
+    quantity: number;
+    priceDetails?: PriceDetailsNonNullableFields;
+    totals?: TotalsNonNullableFields;
+    taxData?: ItemTaxDataNonNullableFields;
+}
+interface SubscriptionChargeNonNullableFields {
+    cycle: number;
+    totals?: TotalsNonNullableFields;
+    invoiceItems: InvoiceItemNonNullableFields[];
+    discount?: InvoiceDiscountNonNullableFields;
+}
+export interface CustomerListUpcomingChargesResponseNonNullableFields {
+    upcomingCharge?: SubscriptionChargeNonNullableFields;
+}
+export interface InitiatePaymentMethodSetupResponseNonNullableFields {
+    paymentOrderId: string;
+}
+export interface PayCycleResponseNonNullableFields {
+    invoiceId: string;
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface UpdateSubscriptionBillingDateResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface CancelSubscriptionResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface PauseSubscriptionResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface ResumeSubscriptionResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+export interface SearchSubscriptionsResponseNonNullableFields {
+    subscriptions: SubscriptionNonNullableFields[];
+}
+interface CountByStatusNonNullableFields {
+    status: SubscriptionStatusEnumSubscriptionStatus;
+    count: number;
+}
+export interface CountSubscriptionsResponseNonNullableFields {
+    countByStatus: CountByStatusNonNullableFields[];
+    total: number;
+}
+export interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
 }
-interface BillingStatusNonNullableFields {
-    currentCycle: number;
-    latestPaymentData?: PaymentDataNonNullableFields;
-    updateBillingDateData?: UpdateBillingDateDataNonNullableFields;
-    gracePeriodData?: GracePeriodDataNonNullableFields;
+export interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
 }
-interface SubscriptionPoliciesNonNullableFields {
-    customerCanCancel: boolean;
-    businessCanExtend: boolean;
-    allowEndOfCycleCancellation: boolean;
+export interface MarkLatestInvoiceAsPaidResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
 }
-interface PauseInfoNonNullableFields {
-    pausePolicy: PausePolicy;
-    pauseAt: PauseAt;
-    resumeAt: ResumeAt;
+export interface MarkBillingCycleAsPaidResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
 }
-interface CancellationInfoNonNullableFields {
-    initiator: HistoryActionInitiator;
+interface AmountByStatusNonNullableFields {
+    status: SubscriptionStatusEnumSubscriptionStatus;
+    amount: number;
 }
-interface FixedPriceNonNullableFields {
-    itemPrice: string;
+export interface GetSubscriptionsStatsResponseNonNullableFields {
+    amountByStatuses: AmountByStatusNonNullableFields[];
+    total: number;
 }
-interface PricingModelNonNullableFields {
-    fixedPrice?: FixedPriceNonNullableFields;
+export interface ExtendSubscriptionResponseNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
 }
-interface ItemChangeNonNullableFields {
-    id: string;
-    pricingModel?: PricingModelNonNullableFields;
-    tax?: TaxNonNullableFields;
+interface UnsupportedReasonNonNullableFields {
+    code: string;
 }
-interface CatalogReferenceNonNullableFields {
-    catalogItemId: string;
+interface UnsupportedActionNonNullableFields {
+    actionType: ActionType;
+    reasons: UnsupportedReasonNonNullableFields[];
 }
-interface ApplicationFeeNonNullableFields {
-    amount: string;
-    discounts: DiscountNonNullableFields[];
+export interface AllowedActionsResponseNonNullableFields {
+    actions: ActionNonNullableFields[];
+    unsupportedActions: UnsupportedActionNonNullableFields[];
 }
-interface ItemNonNullableFields {
-    name: string;
-    catalogReference?: CatalogReferenceNonNullableFields;
-    category: ItemCategory;
-    quantity: number;
-    pricingModel?: PricingModelNonNullableFields;
-    tax?: TaxNonNullableFields;
-    discounts: DiscountNonNullableFields[];
-    applicationFee?: ApplicationFeeNonNullableFields;
+export interface ListUpcomingChargesResponseNonNullableFields {
+    upcomingCharges: SubscriptionChargeNonNullableFields[];
 }
-interface SubscriptionUpdateDataNonNullableFields {
-    itemsToUpdate: ItemChangeNonNullableFields[];
-    itemsToAdd: ItemNonNullableFields[];
-    numberOfRequests: number;
+interface ChargeNonNullableFields {
+    cycleFrom: number;
+    totals?: TotalsNonNullableFields;
 }
-interface SpecificDateSubscriptionUpdateDataNonNullableFields {
-    updateData?: SubscriptionUpdateDataNonNullableFields;
+export interface PreviewSubscriptionChargesResponseNonNullableFields {
+    charges: ChargeNonNullableFields[];
 }
-interface SubscriptionNonNullableFields {
-    name: string;
-    customer?: CustomerNonNullableFields;
-    status: SubscriptionStatusEnumSubscriptionStatus;
-    billingSettings?: BillingSettingsNonNullableFields;
-    billingStatus?: BillingStatusNonNullableFields;
-    shippingAddress?: FullAddressDetailsNonNullableFields;
-    policies?: SubscriptionPoliciesNonNullableFields;
-    pauseInfo?: PauseInfoNonNullableFields;
-    cancellationInfo?: CancellationInfoNonNullableFields;
-    pendingUpdateData?: SubscriptionUpdateDataNonNullableFields;
-    bassManaged: boolean;
-    specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateDataNonNullableFields;
-    items: ItemNonNullableFields[];
+interface SubscriptionChargesNonNullableFields {
+    charges: ChargeNonNullableFields[];
+}
+export interface PreviewSubscriptionsChargesResponseNonNullableFields {
+    subscriptionsCharges: SubscriptionChargesNonNullableFields[];
 }
 interface SubscriptionCreatedNonNullableFields {
     subscription?: SubscriptionNonNullableFields;
@@ -3396,7 +4090,7 @@ interface FreeTrailStartedNonNullableFields {
 interface FreeTrailEndedNonNullableFields {
     subscription?: SubscriptionNonNullableFields;
 }
-interface InvoiceMarkedAsPaidNonNullableFields {
+interface SubscriptionBillingCyclePaidNonNullableFields {
     subscription?: SubscriptionNonNullableFields;
     paidCycle: number;
     invoiceId: string;
@@ -3440,7 +4134,7 @@ interface SubscriptionEventNonNullableFields {
     collectionMethodUpdated?: SubscriptionCollectionMethodUpdatedNonNullableFields;
     freeTrailStarted?: FreeTrailStartedNonNullableFields;
     freeTrailEnded?: FreeTrailEndedNonNullableFields;
-    invoiceMarkedAsPaid?: InvoiceMarkedAsPaidNonNullableFields;
+    billingCyclePaid?: SubscriptionBillingCyclePaidNonNullableFields;
     initiatePaymentMethodSetup?: InitiatedPaymentMethodSetupNonNullableFields;
     subscriptionBoAction?: SubscriptionBackOfficeActionNonNullableFields;
 }
@@ -3452,167 +4146,4 @@ interface SubscriptionHistoryEntryNonNullableFields {
 export interface ListSubscriptionHistoryResponseNonNullableFields {
     historyEntries: SubscriptionHistoryEntryNonNullableFields[];
 }
-export interface GetSubscriptionResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface CustomerCancelSubscriptionResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface CustomerTurnOnAutoRenewalResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface CustomerTurnOffAutoRenewalResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface CustomerExtendSubscriptionResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface QuerySubscriptionsResponseNonNullableFields {
-    subscriptions: SubscriptionNonNullableFields[];
-}
-export interface UpdateSubscriptionPaymentMethodResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-interface ActionNonNullableFields {
-    actionType: ActionType;
-    pausePolicies: PausePolicy[];
-    pauseAt: PauseAt[];
-    resumeAt: ResumeAt[];
-    extendPolicies: ExtendPolicyType[];
-}
-export interface CustomerAllowedActionsResponseNonNullableFields {
-    actions: ActionNonNullableFields[];
-}
-interface RecurringNonNullableFields {
-    cycleNumber: number;
-}
-interface InvoiceDiscountNonNullableFields {
-    amount: string;
-    percentage: string;
-    origin?: DiscountOriginNonNullableFields;
-}
-interface InvoiceApplicationFeeNonNullableFields {
-    amount: string;
-    discount?: InvoiceDiscountNonNullableFields;
-}
-interface PriceDetailsNonNullableFields {
-    price: string;
-    tax?: TaxNonNullableFields;
-    discount?: InvoiceDiscountNonNullableFields;
-    applicationFeeDetails?: InvoiceApplicationFeeNonNullableFields;
-}
-interface LineItemTaxSummaryNonNullableFields {
-    aggregatedTaxAmount: string;
-    aggregatedTaxRate: string;
-    taxableAmount: string;
-}
-interface TaxBreakdownNonNullableFields {
-    taxType: string;
-    taxRate: string;
-    jurisdictionType: string;
-}
-interface ItemTaxDataNonNullableFields {
-    lineItemTaxSummary?: LineItemTaxSummaryNonNullableFields;
-    taxBreakdowns: TaxBreakdownNonNullableFields[];
-}
-interface InvoiceItemNonNullableFields {
-    recurring?: RecurringNonNullableFields;
-    id: string;
-    name: string;
-    catalogReference?: CatalogReferenceNonNullableFields;
-    category: ItemCategory;
-    quantity: number;
-    priceDetails?: PriceDetailsNonNullableFields;
-    totals?: TotalsNonNullableFields;
-    taxData?: ItemTaxDataNonNullableFields;
-}
-interface SubscriptionChargeNonNullableFields {
-    cycle: number;
-    totals?: TotalsNonNullableFields;
-    invoiceItems: InvoiceItemNonNullableFields[];
-    discount?: InvoiceDiscountNonNullableFields;
-}
-export interface CustomerListUpcomingChargesResponseNonNullableFields {
-    upcomingCharge?: SubscriptionChargeNonNullableFields;
-}
-export interface InitiatePaymentMethodSetupResponseNonNullableFields {
-    paymentOrderId: string;
-}
-export interface UpdateSubscriptionBillingDateResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface CancelSubscriptionResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface PauseSubscriptionResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface ResumeSubscriptionResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface SearchSubscriptionsResponseNonNullableFields {
-    subscriptions: SubscriptionNonNullableFields[];
-}
-interface CountByStatusNonNullableFields {
-    status: SubscriptionStatusEnumSubscriptionStatus;
-    count: number;
-}
-export interface CountSubscriptionsResponseNonNullableFields {
-    countByStatus: CountByStatusNonNullableFields[];
-    total: number;
-}
-export interface TurnOnSubscriptionAutoRenewalResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface TurnOffSubscriptionAutoRenewalResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface MarkLatestInvoiceAsPaidResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-export interface MarkInvoiceAsPaidResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-interface AmountByStatusNonNullableFields {
-    status: SubscriptionStatusEnumSubscriptionStatus;
-    amount: number;
-}
-export interface GetSubscriptionsStatsResponseNonNullableFields {
-    amountByStatuses: AmountByStatusNonNullableFields[];
-    total: number;
-}
-export interface ExtendSubscriptionResponseNonNullableFields {
-    subscription?: SubscriptionNonNullableFields;
-}
-interface UnsupportedReasonNonNullableFields {
-    code: string;
-}
-interface UnsupportedActionNonNullableFields {
-    actionType: ActionType;
-    reasons: UnsupportedReasonNonNullableFields[];
-}
-export interface AllowedActionsResponseNonNullableFields {
-    actions: ActionNonNullableFields[];
-    unsupportedActions: UnsupportedActionNonNullableFields[];
-}
-export interface ListUpcomingChargesResponseNonNullableFields {
-    upcomingCharges: SubscriptionChargeNonNullableFields[];
-}
-interface ChargeNonNullableFields {
-    cycleFrom: number;
-    totals?: TotalsNonNullableFields;
-}
-export interface PreviewSubscriptionChargesResponseNonNullableFields {
-    charges: ChargeNonNullableFields[];
-}
-interface SubscriptionChargesNonNullableFields {
-    charges: ChargeNonNullableFields[];
-}
-export interface PreviewSubscriptionsChargesResponseNonNullableFields {
-    subscriptionsCharges: SubscriptionChargesNonNullableFields[];
-}
-export interface PayCycleResponseNonNullableFields {
-    invoiceId: string;
-    subscription?: SubscriptionNonNullableFields;
-}
 export {};