@wix/auto_sdk_subscription_subscriptions 1.0.0

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

@@ -0,0 +1,4379 @@
+export interface Subscription {
+    /**
+     * Subscription's unique id. Automatically generated and read-only.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Date when subscription was created
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date when subscription was updated
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Revision of subscription. Increments upon changes
+     * @readonly
+     */
+    revision?: string | null;
+    /** Subscription name: minLength is 1, maxLength is 150 */
+    name?: string;
+    /** Subscription description. Optional. */
+    description?: string | null;
+    /**
+     * 3. No Start Date:
+     * - If the start_date is not provided, this field will default to "now",
+     * meaning the subscription will start immediately.
+     */
+    startDate?: Date | null;
+    /**
+     * Represents when the subscription will end, relevant for subscriptions with a termed period.
+     * If not provided, will be calculated based on billing schedule. Should be empty for evergreen subscription.
+     * Note: A 13-hour tolerance is applied when validating the end date to handle for time zone differences and minor discrepancies.
+     */
+    endDate?: Date | null;
+    /** Business origin subscription is coming from. In site-level subscription it will be vertical app_id and entity_id */
+    origin?: BusinessOrigin;
+    /** Customer information like id and identity type (member or contact) */
+    customer?: Customer;
+    /**
+     * Status of subscription
+     * @readonly
+     */
+    status?: SubscriptionStatusEnumSubscriptionStatus;
+    /** Billing details parameters including schedule, currency, etc. */
+    billingSettings?: BillingSettings;
+    /**
+     * Includes many attributes about billing status of the subscription
+     * @readonly
+     */
+    billingStatus?: BillingStatus;
+    /** Shipping address associated with subscription. At the moment used only for payments. Optional. */
+    shippingAddress?: FullAddressDetails;
+    /** Restrictions on possible subscription actions. If not provided, default policies are all restrictions enabled. */
+    policies?: SubscriptionPolicies;
+    /**
+     * Information related to either paused subscription or scheduled for future pause
+     * @readonly
+     */
+    pauseInfo?: PauseInfo;
+    /**
+     * Information related to cancellation for already canceled subscription or scheduled for cancel
+     * @readonly
+     */
+    cancellationInfo?: CancellationInfo;
+    /**
+     * Pending update for the next billing cycle
+     * @readonly
+     */
+    pendingUpdateData?: SubscriptionUpdateData;
+    /**
+     * 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.
+     */
+    metadata?: Record<string, string>;
+    /**
+     * Pending update for a specific date
+     * @readonly
+     */
+    specificDatePendingUpdateData?: SpecificDateSubscriptionUpdateData;
+    /**
+     * ChangesCounter of subscription. Increments upon every change to the domain
+     * @readonly
+     */
+    changesCounter?: string | null;
+    /** Billing order id. Optional. */
+    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. */
+    businessLocationId?: string | null;
+    /** items, minSize is 1, maxSize is 100 */
+    items?: Item[];
+}
+export interface BusinessOrigin {
+    appId?: string | null;
+    entityId?: string | null;
+}
+export interface Customer extends CustomerIdOneOf {
+    /**
+     * Visitor ID of the customer. Available when the customer is an anonymous
+     * site visitor.
+     */
+    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).
+     */
+    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).
+     */
+    memberId?: string;
+    /** Wix account ID */
+    accountId?: string;
+}
+/** @oneof */
+export interface CustomerIdOneOf {
+    /**
+     * Visitor ID of the customer. Available when the customer is an anonymous
+     * site visitor.
+     */
+    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).
+     */
+    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).
+     */
+    memberId?: string;
+    /** Wix account ID */
+    accountId?: string;
+}
+export declare enum SubscriptionStatusEnumSubscriptionStatus {
+    UNKNOWN = "UNKNOWN",
+    /** Subscription created in this status, but hasn't been paid for yet. Filtered out from subscriptions querying. */
+    DRAFT = "DRAFT",
+    /** Subscription that will be active in future. */
+    PENDING = "PENDING",
+    /** Subscription is active */
+    ACTIVE = "ACTIVE",
+    /** Subscription is paused */
+    PAUSED = "PAUSED",
+    /** Subscription was ended */
+    ENDED = "ENDED",
+    /** Subscription was canceled or auto-renew off. Ended before its time. */
+    CANCELED = "CANCELED"
+}
+export interface BillingSettings {
+    /** Currency of all subscription items prices. Three letter ISO currency code. https://en.wikipedia.org/wiki/ISO_4217 */
+    currency?: string;
+    /** customer payment source to make recurring payments with */
+    paymentMethod?: PaymentMethod;
+    /** Instructs how payments will be collected. */
+    collectionMethod?: CollectionMethodEnumCollectionMethod;
+    /**
+     * Duration of cycle. For example, 1 MONTH, 2 WEEKS, 7 DAYS, 1 YEAR etc.
+     * 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. */
+    totalCycles?: number | null;
+    /** If set to false, subscription will be canceled at the next billing cycle. */
+    cycleAutoRenew?: boolean;
+    /** Billing Schedule to be defined in order to override default billing schedule */
+    customBillingSchedule?: CustomBillingSchedule;
+    /** Definition of trial period */
+    freeTrialDuration?: Duration;
+    /**
+     * Shipping costs collected each cycle
+     * @deprecated
+     * @replacedBy shipping_charges
+     * @targetRemovalDate 2024-10-31
+     */
+    shippingFee?: string | null;
+    /** Billing address associated with subscription to be used for payments. */
+    billingAddress?: FullAddressDetails;
+    taxSettings?: TaxSettings;
+    /**
+     * Fees that are only added to an invoice when a specific condition is met.
+     * For example, a setup fee that only applies to the very first invoice of a
+     * subscription.
+     *
+     * Max: 5 additional fees
+     */
+    additionalFees?: AdditionalFee[];
+    /** Shipping fee charges */
+    shippingCharges?: ShippingCharges;
+    /** General discount that applied to all items in the subscription */
+    discounts?: Discount[];
+    /**
+     * Details about the external collection service.
+     * Only set when the collection_method is EXTERNAL.
+     */
+    externalCollectionDetails?: ExternalCollectionDetails;
+}
+export interface PaymentMethod {
+    /** reference to payment source id stored in payments system */
+    _id?: string;
+}
+export declare enum CollectionMethodEnumCollectionMethod {
+    UNKNOWN = "UNKNOWN",
+    /** Subscriber automatically charged */
+    AUTO_CHARGE = "AUTO_CHARGE",
+    /** Payments manually collected and managed by owner */
+    OFFLINE = "OFFLINE",
+    /** Payment will be collected somehow. Billing only issues invoice per cycle. */
+    SEND_INVOICE = "SEND_INVOICE",
+    /** Payment will be collected externally */
+    EXTERNAL = "EXTERNAL",
+    /** Indicates the product has a zero amount, meaning its free with no payment required. */
+    FREE = "FREE"
+}
+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. */
+    count?: number | null;
+}
+export declare enum DurationUnit {
+    UNKNOWN = "UNKNOWN",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+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
+     */
+    cyclesToPayOnCreation?: number | null;
+}
+export interface FullAddressDetails {
+    /** Details about the person associated with the address. */
+    contactDetails?: FullAddressContactDetails;
+    /** Information about the address. */
+    address?: Address;
+}
+export interface FullAddressContactDetails {
+    /** First name of the contact. */
+    firstName?: string | null;
+    /** Last name of the contact. */
+    lastName?: string | null;
+    /** Phone number of the contact. */
+    phone?: string | null;
+    /** Company associated with the contact. */
+    company?: string | null;
+    /** Email address of the contact. */
+    email?: string | null;
+}
+export interface Address extends AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine1?: string | null;
+    /**
+     * 2-letter country code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format.
+     */
+    country?: string | null;
+    /**
+     * Subdivision. Usually a state, region, prefecture, or province code,
+     * according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
+     */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+}
+/** @oneof */
+export interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+export interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+export interface TaxSettings {
+    /** If true then taxes are included in given prices */
+    inclusive?: boolean;
+}
+export interface AdditionalFee {
+    /**
+     * Name of the conditional fee.
+     *
+     * Max: 500 characters
+     */
+    name?: string;
+    /**
+     * Amount of the conditional fee.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * When the fee is added to the invoice.
+     *
+     * + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
+     * + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
+     * @deprecated When the fee is added to the invoice.
+     *
+     * + `UNKNOWN_FEE_TRIGGER`: There is no information about when the fee is added to an invoice.
+     * + `FIRST_PAYMENT`: The fee is only added to the very first invoice of a subscription.
+     * @replacedBy cycles
+     * @targetRemovalDate 2025-12-31
+     */
+    trigger?: AdditionalFeeTrigger;
+    /** Information about the tax of the conditional fee. */
+    tax?: Tax;
+    /**
+     * Specifies the cycles during which the fee will be applied. If this field is provided,
+     * it determines the exact range of cycles the fee applies to. The logic is as follows:
+     *
+     * - `cycle_from`: The first cycle the fee will be added to. Must be greater than 0.
+     * - `number_of_cycles`: The number of consecutive cycles the fee will be applied to,
+     * starting from `cycle_from`. If not specified, the fee applies to all cycles starting
+     * from `cycle_from`.
+     *
+     * Example:
+     * - `cycle_from = 1, number_of_cycles = 3`: Fee applies to cycles 1, 2, and 3.
+     * - `cycle_from = 2, number_of_cycles = None`: Fee applies to cycles 2 and onward indefinitely.
+     *
+     * If `cycles` is not specified (`None`), the fee will be applied on all cycles.
+     */
+    cycles?: Cycles;
+    /** Indicates the source of the fee, Contains app_id and entity_id */
+    origin?: Origin;
+}
+export declare enum AdditionalFeeTrigger {
+    UNKNOWN = "UNKNOWN",
+    /** Charge upon subscription first payment */
+    FIRST_PAYMENT = "FIRST_PAYMENT"
+}
+export interface Tax extends TaxValueOneOf {
+    /**
+     * Tax amount for the invoice's line item. Available when the tax is an
+     * amount and not a precentage.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * Tax amount for the invoice's line item price and application fee.
+     * Can't be combined with `invoiceItems.priceDetails.discount`.
+     * Available when the tax is a precentage and not an amount.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     */
+    percentage?: string;
+    /** Dynamic tax calculation */
+    dynamic?: DynamicTax;
+}
+/** @oneof */
+export interface TaxValueOneOf {
+    /**
+     * Tax amount for the invoice's line item. Available when the tax is an
+     * amount and not a precentage.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * Tax amount for the invoice's line item price and application fee.
+     * Can't be combined with `invoiceItems.priceDetails.discount`.
+     * Available when the tax is a precentage and not an amount.
+     *
+     * Min: `0.01`
+     * Max: `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 */
+    taxGroupId?: string | null;
+    /** Taxable address used to calculate tax */
+    taxableAddressType?: TaxableAddressType;
+}
+export declare enum TaxableAddressType {
+    UNKNOWN = "UNKNOWN",
+    /** Tax will be calculated using a single address */
+    BUSINESS = "BUSINESS",
+    /** Tax will be calculated using multiple address (from BUSINESS to BILLING) */
+    BILLING = "BILLING",
+    /** Tax will be calculated using multiple address (from BUSINESS to SHIPPING) */
+    SHIPPING = "SHIPPING"
+}
+export interface Cycles {
+    /** The cycle will start. Minimum cycle number is 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. */
+    numberOfCycles?: number | null;
+}
+export interface Origin {
+    appId?: string;
+    entityId?: string;
+}
+export interface ShippingCharges {
+    /**
+     * Amount of the shipping fee in `0.00` format.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /** Tax of the shipping fee */
+    tax?: Tax;
+    discounts?: Discount[];
+}
+export interface Discount extends DiscountValueOneOf {
+    /**
+     * Discount amount.
+     * Available when the discount is an amount.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * Discount percentage.
+     * Available when the discount is a parcentage value.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     */
+    percentage?: string;
+    cycles?: DiscountCycles;
+    /** Discount origin is coming from. Contains app_id and entity_id */
+    origin?: DiscountOrigin;
+}
+/** @oneof */
+export interface DiscountValueOneOf {
+    /**
+     * Discount amount.
+     * Available when the discount is an amount.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * Discount percentage.
+     * Available when the discount is a parcentage value.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     */
+    percentage?: string;
+}
+export interface DiscountCycles {
+    /** The cycle from which the discount will start. Minimum cycle number is 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. */
+    numberOfCycles?: number | null;
+}
+export interface DiscountOrigin {
+    appId?: string;
+    entityId?: string;
+}
+export interface ExternalCollectionDetails {
+    /** The name of the external collector. */
+    collectorName?: string;
+}
+export interface BillingStatus {
+    /**
+     * Current cycle of subscription billing schedule. When billing schedule starts cycles start from 1
+     * and incremented each next billing cycle.
+     * In case billing schedule not started (free trial, pay later start later) then current_cycle will remain 0
+     */
+    currentCycle?: number;
+    /** how many cycled are remaining, For auto-renew subscriptions is not set. */
+    remainingCycles?: number | null;
+    /** Date when charge will be for next billing cycle */
+    nextBillingDate?: Date | null;
+    /** Previous Date charged for previous billing cycle */
+    previousBillingDate?: Date | null;
+    /** last payment details */
+    latestPaymentData?: PaymentData;
+    /** Free trial data */
+    freeTrialData?: FreeTrialData;
+    /**
+     * Grace period information during grace period after payment failure
+     * @readonly
+     */
+    gracePeriodData?: GracePeriodData;
+}
+/** TODO: fill docs */
+export interface PaymentData {
+    invoiceId?: string;
+    paymentStatus?: PaymentStatus;
+    totals?: Totals;
+    initialFailedPaymentDate?: Date | null;
+}
+export declare enum PaymentStatus {
+    /** Payment status unknown */
+    UNKNOWN = "UNKNOWN",
+    /** Payment has not been paid */
+    UNPAID = "UNPAID",
+    /** Payment has been paid // TODO: p13n review: we are not sending event when in SEND_INVOICE mode cycle was paid. should we and which event? */
+    PAID = "PAID",
+    /** Payment failed */
+    FAILED = "FAILED"
+}
+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`
+     * @readonly
+     */
+    totalPrice?: string;
+    /**
+     * Subtotal of all line items that belong to the subscription.
+     * Calculated as: `sum_{i=1}^{n} (itemPrice[i] * quantity[i])`
+     * @readonly
+     */
+    subtotal?: string;
+    /**
+     * Total tax.
+     * @readonly
+     */
+    tax?: string | null;
+    /**
+     * Total discount.
+     * @readonly
+     */
+    discount?: string | null;
+    /**
+     * Total application fee.
+     * @readonly
+     */
+    applicationFee?: string | null;
+    /**
+     * Total shipping fee.
+     * @readonly
+     */
+    shippingFee?: string | null;
+    /**
+     * Total extra charges without tax.
+     * @readonly
+     */
+    extraCharge?: string | null;
+    /**
+     * Total credits without tax.
+     * @readonly
+     */
+    credit?: string | null;
+    /**
+     * The tax amount for the proration, which is also included in the total tax.
+     * @readonly
+     */
+    prorationTax?: string | null;
+}
+export interface FreeTrialData {
+    /**
+     * Date when free trial starts
+     * @readonly
+     */
+    startDate?: Date | null;
+    /**
+     * Date when free trial ends
+     * @readonly
+     */
+    endDate?: Date | null;
+}
+export interface UpdateBillingDateData {
+    /**
+     * Date until the subscription is paid for.
+     * Different from `nextBillingDate` only when the next billing date is updated without immediately issuing a new invoice.
+     */
+    paidUntil?: Date | null;
+    /** Information about how to adjust the item's payment due to the update of the billing date */
+    proration?: Proration;
+}
+export interface Proration extends ProrationTypeOneOf {
+    /**
+     * BASS automatically calculates the proration amount based on the number
+     * of days added to or removed from the current billing cycle. BASS uses
+     * this formula to calculate the charge or credit amount:
+     * `(Subscription total for the current billing cycle) * (number of days added to or removed from the current billing cycle) / (total number of days for the current billing cycle before the adjustment)`.
+     * For example, the customer has paid 100 UDS for the current
+     * billing cycle that last 31 days, and you want to extend the cycle by 8
+     * days. Then, BASS calculates the proration amount like this:
+     * `100 USD * 8 days / 31 days`, which equals `25.81 USD`.
+     */
+    timeBased?: TimeBasedProration;
+    /** Proration amount that's based on your custom calculation. */
+    custom?: CustomProration;
+}
+/** @oneof */
+export interface ProrationTypeOneOf {
+    /**
+     * BASS automatically calculates the proration amount based on the number
+     * of days added to or removed from the current billing cycle. BASS uses
+     * this formula to calculate the charge or credit amount:
+     * `(Subscription total for the current billing cycle) * (number of days added to or removed from the current billing cycle) / (total number of days for the current billing cycle before the adjustment)`.
+     * For example, the customer has paid 100 UDS for the current
+     * billing cycle that last 31 days, and you want to extend the cycle by 8
+     * days. Then, BASS calculates the proration amount like this:
+     * `100 USD * 8 days / 31 days`, which equals `25.81 USD`.
+     */
+    timeBased?: TimeBasedProration;
+    /** Proration amount that's based on your custom calculation. */
+    custom?: CustomProration;
+}
+export interface TimeBasedProration {
+}
+export interface CustomProration extends CustomProrationAmountOneOf {
+    /**
+     * Proration charge amount that's based on your custom calculation.
+     * Increases the total that the customer must pay with the next invoice.
+     *
+     * Min: `0.01`
+     */
+    charge?: string;
+    /**
+     * Proration credit amount that's based on your custom calculation.
+     * Lowers the total that the customer must pay with the next invoice.
+     *
+     * Min: `0.01`
+     */
+    credit?: string;
+}
+/** @oneof */
+export interface CustomProrationAmountOneOf {
+    /**
+     * Proration charge amount that's based on your custom calculation.
+     * Increases the total that the customer must pay with the next invoice.
+     *
+     * Min: `0.01`
+     */
+    charge?: string;
+    /**
+     * Proration credit amount that's based on your custom calculation.
+     * Lowers the total that the customer must pay with the next invoice.
+     *
+     * Min: `0.01`
+     */
+    credit?: string;
+}
+export interface GracePeriodData {
+    /**
+     * Grace period start date
+     * @readonly
+     */
+    startDate?: Date | null;
+    /**
+     * Grace period end date
+     * @readonly
+     */
+    endDate?: Date | null;
+    /** Automatic retry data during grade period, if have any. Optional. */
+    automaticRetryData?: AutomaticRetryData;
+}
+export interface AutomaticRetryData {
+    enabled?: boolean;
+}
+export interface SubscriptionPolicies {
+    /** Subscription can be canceled by the customer who bought it */
+    customerCanCancel?: boolean;
+    /** Subscription end date can be updated by business */
+    businessCanExtend?: boolean;
+    /** Subscription can be canceled not only immediately, but also at end of billing cycle by turning off auto-renew */
+    allowEndOfCycleCancellation?: boolean;
+}
+export interface PauseInfo {
+    pausePolicy?: PausePolicy;
+    pauseAt?: PauseAt;
+    startDate?: Date | null;
+    startCycle?: number | null;
+    resumeAt?: ResumeAt;
+    resumeDate?: Date | null;
+    resumeCycle?: number | null;
+}
+export declare enum PausePolicy {
+    NONE = "NONE",
+    /** Pause the payment and the service. When resuming, the subscription end date is extended by the number of cycles postponed, and if the pause happened in a middle of a cycle, the payment date is postponed by the amount of days that already paid. */
+    SERVICE_AND_PAYMENTS = "SERVICE_AND_PAYMENTS",
+    /** Pause the service and continue the billing. When resuming, extend the service by the time that was paused */
+    SERVICE_ONLY = "SERVICE_ONLY"
+}
+export declare enum PauseAt {
+    /** Cancel scheduled pause */
+    NONE = "NONE",
+    /** Pause the subscription now */
+    IMMEDIATELY = "IMMEDIATELY",
+    /** Pause the subscription at the next billing date */
+    NEXT_BILLING_DATE = "NEXT_BILLING_DATE",
+    /** A specific date must be defined in Schedule.specific_date */
+    SPECIFIC_DATE = "SPECIFIC_DATE",
+    /** The number of cycles must be defined in Schedule.number_of_cycles */
+    NUMBER_OF_CYCLES_FROM_TODAY = "NUMBER_OF_CYCLES_FROM_TODAY"
+}
+export declare enum ResumeAt {
+    /** Cancel scheduled resume */
+    NONE = "NONE",
+    /** Resume the subscription now */
+    IMMEDIATELY = "IMMEDIATELY",
+    /** Resume the subscription at the next billing date */
+    NEXT_BILLING_DATE = "NEXT_BILLING_DATE",
+    /** A specific date must be defined in Schedule.specific_date */
+    SPECIFIC_DATE = "SPECIFIC_DATE"
+}
+export interface CancellationInfo {
+    /** Subscription cancel date. Can contain a future or past date */
+    cancellationDate?: Date | null;
+    /** Initiator for cancellation */
+    initiator?: HistoryActionInitiator;
+    /** Reason for cancellation. Optional. */
+    reason?: string | null;
+}
+export declare enum HistoryActionInitiator {
+    UNDEFINED = "UNDEFINED",
+    BUSINESS = "BUSINESS",
+    CUSTOMER = "CUSTOMER",
+    SYSTEM = "SYSTEM",
+    PAYMENT_FAILURE = "PAYMENT_FAILURE"
+}
+export interface SubscriptionUpdateData {
+    itemsToUpdate?: ItemChange[];
+    itemsToAdd?: Item[];
+    itemsToDelete?: string[] | null;
+    /** @readonly */
+    numberOfRequests?: number;
+}
+export interface ItemChange {
+    /** Item ID */
+    _id?: string;
+    pricingModel?: PricingModel;
+    quantity?: number | null;
+    tax?: Tax;
+}
+export interface PricingModel extends PricingModelModelOneOf {
+    /** Details about the fixed item price. */
+    fixedPrice?: FixedPrice;
+}
+/** @oneof */
+export interface PricingModelModelOneOf {
+    /** Details about the fixed item price. */
+    fixedPrice?: FixedPrice;
+}
+export interface FixedPrice {
+    /**
+     * Fixed item price with a period as a decimal separator. For example, `3.99`.
+     * Price doesn't include tax, discounts, or application fee.
+     *
+     * Min: `0.01`
+     */
+    itemPrice?: string;
+}
+export interface Item {
+    /**
+     * Unique identifier of subscription item. Automatically generated and read-only.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Name of the item. Typically product name. */
+    name?: string;
+    /** Description of the item. */
+    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 */
+    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?: 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.
+     */
+    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.
+     */
+    metadata?: Record<string, string>;
+}
+export interface CatalogReference {
+    /** Product ID from the external catalog. */
+    catalogItemId?: string;
+    /**
+     * ID of the app that the product catalog belongs to.
+     * When omitted, BASS assumes that the product belongs to the subscription's
+     * `origin.appId`.
+     *
+     * Min: 1 character
+     * Max: 50 characters
+     */
+    appId?: string | null;
+}
+export declare enum ItemCategory {
+    UNKNOWN = "UNKNOWN",
+    PHYSICAL = "PHYSICAL",
+    DIGITAL = "DIGITAL"
+}
+export interface ApplicationFee extends ApplicationFeeValueOneOf {
+    /** Amount of the application fee in `0.00` format. */
+    amount?: string;
+    /**
+     * Discounts for the application fee.
+     *
+     * Max: 5 discounts
+     */
+    discounts?: Discount[];
+}
+/** @oneof */
+export interface ApplicationFeeValueOneOf {
+    /** Amount of the application fee in `0.00` format. */
+    amount?: string;
+}
+export interface SpecificDateSubscriptionUpdateData {
+    updateData?: SubscriptionUpdateData;
+    executionDate?: Date | null;
+}
+export interface PlatformOrigin {
+    appId?: string | null;
+    entityId?: string | null;
+}
+export interface InvoiceMarkedAsPaid {
+    /** 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 */
+    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.
+     */
+    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;
+}
+/** @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 SubscriptionCreated {
+    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;
+}
+/**
+ * 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;
+}
+/**
+ * Sent each time a subscription status has been set to Canceled
+ * Canceled shows that a subscription was canceled and ended its life cycle as a result of some intervention
+ * For example:
+ * * A user decided to cancel a subscription before the original end date
+ * * A subscription is canceled due to bad payment
+ */
+export interface SubscriptionCanceled {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+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 ResumeSubscriptionRequested {
+    subscription?: Subscription;
+    resumeAt?: ResumeAt;
+    actionDetails?: ActionDetails;
+}
+export interface ScheduledPauseCanceled {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+export interface ScheduledResumeCanceled {
+    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 SubscriptionAutoRenewalTurnedOn {
+    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;
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+/** @oneof */
+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 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 SubscriptionCollectionMethodUpdated {
+    subscription?: Subscription;
+    newCollectionMethod?: CollectionMethodEnumCollectionMethod;
+    previousCollectionMethod?: CollectionMethodEnumCollectionMethod;
+}
+export interface FreeTrailStarted {
+    subscription?: Subscription;
+}
+export interface FreeTrailEnded {
+    subscription?: Subscription;
+}
+export interface InitiatedPaymentMethodSetup {
+    subscription?: Subscription;
+}
+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;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * 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
+     */
+    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;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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.
+     */
+    currentEntity?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: 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;
+    paymentMethodId: string;
+}
+export interface UpdateSubscriptionPaymentMethodResponse {
+    subscription?: Subscription;
+}
+export interface CustomerAllowedActionsRequest {
+    _id: string;
+}
+export interface CustomerAllowedActionsResponse {
+    actions?: Action[];
+}
+export interface Action {
+    actionType?: ActionType;
+    pausePolicies?: PausePolicy[];
+    pauseAt?: PauseAt[];
+    resumeAt?: ResumeAt[];
+    extendPolicies?: ExtendPolicyType[];
+}
+export declare enum ActionType {
+    NONE = "NONE",
+    CREATION = "CREATION",
+    CANCEL = "CANCEL",
+    CYCLE_AUTO_RENEW_ON = "CYCLE_AUTO_RENEW_ON",
+    CYCLE_AUTO_RENEW_OFF = "CYCLE_AUTO_RENEW_OFF",
+    PAUSE = "PAUSE",
+    RESUME = "RESUME",
+    MARK_AS_PAID = "MARK_AS_PAID",
+    EXTEND = "EXTEND",
+    UPDATE = "UPDATE",
+    UPDATE_START_DATE = "UPDATE_START_DATE",
+    UPM = "UPM",
+    UPDATE_BILLING_DATE = "UPDATE_BILLING_DATE",
+    UPDATE_COLLECTION_METHOD = "UPDATE_COLLECTION_METHOD"
+}
+export declare enum ExtendPolicyType {
+    PERIOD = "PERIOD",
+    BILLING_CYCLE = "BILLING_CYCLE"
+}
+export interface CustomerListUpcomingChargesRequest {
+    /** Subscription id upcoming charge to be previewed for */
+    _id: string;
+}
+export interface CustomerListUpcomingChargesResponse {
+    /** Subscription upcoming charge. Will be empty if no more billing scheduled. */
+    upcomingCharge?: SubscriptionCharge;
+}
+export interface SubscriptionCharge {
+    /** cycle of future charge */
+    cycle?: number;
+    /** date of the charge */
+    billingDate?: Date | null;
+    /** breakdown of charge */
+    totals?: Totals;
+    /** List of items in the invoice */
+    invoiceItems?: InvoiceItem[];
+    /** Discount details for the invoice */
+    discount?: InvoiceDiscount;
+}
+export interface InvoiceItem extends InvoiceItemPaymentTypeOneOf {
+    /** Information about a line item that's purchased on a recurring basis. */
+    recurring?: Recurring;
+    /**
+     * Empty object that's available when the line item is purchased a single
+     * time, not on a recurring basis.
+     */
+    oneTime?: OneTime;
+    /** ID of the invoice line item. */
+    _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.
+     */
+    subscriptionId?: string | null;
+    /**
+     * Name of the invoice line item.
+     * Typically the product name.
+     *
+     * Max: 200 characters
+     */
+    name?: string;
+    /**
+     * Description of the invoice line item.
+     *
+     * Max: 500 characters
+     */
+    description?: string | null;
+    /** Information about the product from the external product catalog. */
+    catalogReference?: CatalogReference;
+    /**
+     * Product category.
+     *
+     * + `"UNKNOWN"`: There is no information about the product category.
+     * + `"PHYSICAL"`: A physical product that's shipped to the shipping address.
+     * + `"DIGITAL"`: A digital product that doesn't require shipping.
+     */
+    category?: ItemCategory;
+    /** Quantity of the invoice line item. */
+    quantity?: number;
+    /** Information about the invoice line item's price. */
+    priceDetails?: PriceDetails;
+    /** Information about the invoice line item's totals */
+    totals?: Totals;
+    /**
+     * Information about the invoice line item's tax data
+     * @readonly
+     */
+    taxData?: ItemTaxData;
+}
+/** @oneof */
+export interface InvoiceItemPaymentTypeOneOf {
+    /** Information about a line item that's purchased on a recurring basis. */
+    recurring?: Recurring;
+    /**
+     * Empty object that's available when the line item is purchased a single
+     * time, not on a recurring basis.
+     */
+    oneTime?: OneTime;
+}
+export interface Recurring {
+    /**
+     * Number of cycles. Describes how many times a customer purchases the line item
+     * on a recurring basis.
+     */
+    cycleNumber?: number;
+}
+export interface OneTime {
+}
+export interface PriceDetails {
+    /**
+     * Price of the invoice line item in `0.00` format.
+     * A minus sign (-) indicates that the amount is negative.
+     */
+    price?: string;
+    /** Information about the invoice line item's tax. */
+    tax?: Tax;
+    /** Discount that's applied to a specicific invoice line item. */
+    discount?: InvoiceDiscount;
+    /**
+     * Application fee. Set by the origin app, and not by BASS. Wix receives the
+     * full `applicationFee`, while the merchant doesn't receive any portion of it.
+     */
+    applicationFeeDetails?: InvoiceApplicationFee;
+}
+export interface InvoiceDiscount extends InvoiceDiscountValueOneOf {
+    /**
+     * Discount amount.
+     * Available when the discount is an amount.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * Discount percentage.
+     * Available when the discount is a percentage value.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     */
+    percentage?: string;
+    /** Indicates the source of the discount. . Contains app_id and entity_id */
+    origin?: DiscountOrigin;
+}
+/** @oneof */
+export interface InvoiceDiscountValueOneOf {
+    /**
+     * Discount amount.
+     * Available when the discount is an amount.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * Discount percentage.
+     * Available when the discount is a percentage value.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     */
+    percentage?: string;
+}
+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.
+     */
+    amount?: string;
+    /** Information about the discount for the invoice line item's application fee. */
+    discount?: InvoiceDiscount;
+}
+/** @oneof */
+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.
+     */
+    amount?: string;
+}
+export interface ItemTaxData {
+    /** Aggregated tax from tax_breakdowns */
+    lineItemTaxSummary?: LineItemTaxSummary;
+    /** A detailed description of all the tax authorities applied on this item. */
+    taxBreakdowns?: TaxBreakdown[];
+}
+export interface LineItemTaxSummary {
+    /** Calculated from external tax summary */
+    aggregatedTaxAmount?: string;
+    /** Aggregated from tax_breakdowns */
+    aggregatedTaxRate?: string;
+    /** Total taxable amount for this line item. */
+    taxableAmount?: string;
+    /** Aggregated from tax_breakdowns after applying exemptions */
+    finalTaxAmount?: string | null;
+}
+export interface TaxBreakdown {
+    taxType?: string;
+    taxRate?: string;
+    taxAmount?: string | null;
+    taxableAmount?: string | null;
+    nonTaxableAmount?: string | null;
+    /** Name of the tax that was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. */
+    taxName?: string | null;
+    /** Jurisdiction that taxes were calculated for. */
+    jurisdiction?: string | null;
+    /** Type of jurisdiction that taxes were calculated for. */
+    jurisdictionType?: string;
+}
+export interface InitiatePaymentMethodSetupRequest {
+    _id: string;
+    paymentMode?: PaymentMode;
+    paymentSettings?: PaymentSettings;
+}
+export interface PaymentSettings {
+    /** Allowed payment providers for Subscriptions, for example to limit subscriptions to be created only with "Wix Payments" provider. */
+    allowedProviderIds?: string[];
+    /** payment order method, define how the order was applied */
+    orderMethod?: OrderMethod;
+    /** Wix Pay callback url(s) to return buyer to a third party system */
+    redirectUrls?: RedirectUrls;
+    paymentMethodId?: string | null;
+    /**
+     * Specifies an alternative origin for processing the payment.
+     * When set, the payment order will be created with the specified origin
+     * instead of the default origin.
+     */
+    paymentOrigin?: PaymentOrigin;
+}
+export declare enum OrderMethod {
+    UNKNOWN = "UNKNOWN",
+    MOTO = "MOTO",
+    NOT_MOTO = "NOT_MOTO"
+}
+export interface RedirectUrls {
+    /** URL to redirect buyer in case of approved (successful) transaction (required) */
+    successUrl?: string;
+    /** URL to redirect buyer in case of failed/rejected transaction (required) */
+    errorUrl?: string;
+    /** URL to redirect buyer in case of buyer canceled the transaction (optional, default: `{error_url}`) */
+    cancelUrl?: string;
+    /**
+     * URL to redirect buyer in case of pending transaction (that might take some time to process) (optional, default:
+     * `{success_url}`)
+     */
+    pendingUrl?: string;
+}
+export interface PaymentOrigin {
+    /** ID of the app for which the Payment will create the order on. For example, Paypal. */
+    appId?: string;
+    /** Id of the entity that order will be created on */
+    instanceId?: string;
+}
+export interface InitiatePaymentMethodSetupResponse {
+    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;
+    /**
+     * 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 */
+    _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 */
+    _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;
+    /**
+     * 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 UpdateSubscriptionOriginRequest {
+    /** ID of the subscription to update origin. */
+    _id?: string;
+    /** Origin entity ID of the subscription to update. */
+    entityId?: string;
+}
+export interface UpdateSubscriptionOriginResponse {
+    /** Updated subscription. */
+    subscription?: Subscription;
+}
+export interface ReviseSubscriptionRequest {
+    /** Subscription ID */
+    _id?: string;
+    /** 0 for no revision, maxSize is 100 */
+    items?: Item[];
+}
+export interface ReviseSubscriptionResponse {
+    subscription?: Subscription;
+}
+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 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_.
+     */
+    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_.
+     */
+    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
+     */
+    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. */
+    itemsToAdd?: Item[];
+}
+export interface BulkItemChange {
+    /** Information about the new item price. */
+    pricingModel?: PricingModel;
+    /**
+     * New item quantity.
+     *
+     * 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 {
+    _id?: string;
+    revision?: string;
+}
+export interface DeleteSubscriptionResponse {
+}
+export interface CancelSubscriptionRequest {
+    _id: string;
+    actionContext: ActionContext;
+}
+export interface ActionContext {
+    initiator?: ActionInitiator;
+    /** Optional action reason message */
+    reason?: string | null;
+}
+export declare enum ActionInitiator {
+    UNDEFINED = "UNDEFINED",
+    BUSINESS = "BUSINESS",
+    CUSTOMER = "CUSTOMER",
+    SYSTEM = "SYSTEM"
+}
+export interface CancelSubscriptionResponse {
+    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 PauseSubscriptionResponse {
+    subscription?: Subscription;
+}
+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 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 {
+    _id: string;
+    actionContext: ActionContext;
+}
+export interface TurnOnSubscriptionAutoRenewalResponse {
+    subscription?: Subscription;
+}
+export interface TurnOffSubscriptionAutoRenewalRequest {
+    _id: string;
+    actionContext: ActionContext;
+}
+export interface TurnOffSubscriptionAutoRenewalResponse {
+    subscription?: Subscription;
+}
+export interface MarkLatestInvoiceAsPaidRequest {
+    /** The ID of the offline subscription to mark as paid its latest invoice */
+    subscriptionId: string;
+}
+export interface MarkLatestInvoiceAsPaidResponse {
+    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 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 interface MarkInvoiceAsPaidResponse {
+    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 */
+    extensionBillingCycles?: number;
+    /** The ID of the subscription to be extended */
+    _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 */
+    extensionBillingCycles?: number;
+}
+export interface ExtendSubscriptionResponse {
+    /** The now extended subscription */
+    subscription?: Subscription;
+}
+export interface AllowedActionsRequest {
+    _id: string;
+    /** List of additional fields to be included in the response. */
+    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. */
+    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. */
+    reasons?: UnsupportedReason[];
+}
+export interface UnsupportedReason {
+    code?: string;
+    description?: string | null;
+}
+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 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. */
+    cycleCount?: number | null;
+    /** The breakdown of the charge */
+    totals?: Totals;
+    /** The billing date from which the charge starts */
+    cycleBillingDate?: Date | null;
+}
+export interface PreviewSubscriptionsChargesRequest {
+    /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
+    subscriptionsBillingDetails?: SubscriptionBillingDetails[];
+    /**
+     * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
+     * For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
+     * $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
+     * - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
+     * - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
+     * - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
+     * If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
+     * 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.
+     */
+    numberOfNextRecurringCharges?: number | null;
+}
+export interface SubscriptionBillingDetails {
+    /** External identifier of the subscription */
+    externalId?: string | null;
+    /** Billing details parameters including schedule, currency, etc. */
+    billingSettings?: BillingSettings;
+    /** Items, minSize is 1, maxSize is 100 */
+    items?: Item[];
+    /** Subscription start date, now if not set */
+    startDate?: Date | null;
+    /** Shipping address associated with subscription. At the moment used only for payments. Optional. */
+    shippingAddress?: FullAddressDetails;
+}
+export interface PreviewSubscriptionsChargesResponse {
+    /** Charges for the subscriptions, including an identifier. */
+    subscriptionsCharges?: SubscriptionCharges[];
+}
+export interface SubscriptionCharges {
+    /** External identifier of the subscription */
+    externalId?: string | null;
+    /** Charges for subscription. */
+    charges?: Charge[];
+}
+export interface CreateSubscriptionForOrderRequest {
+    /** Subscription needs to be created */
+    subscription?: Subscription;
+    /** Optional unique identifier for this request in order to prevent subscription duplications */
+    idempotencyKey?: string | null;
+}
+export interface CreateSubscriptionForOrderResponse {
+    /** Created subscription */
+    subscription?: Subscription;
+    /** Non-persistent invoice */
+    invoice?: Invoice;
+}
+/** An invoice includes information about the subscription and the customer. */
+export interface Invoice {
+    /**
+     * Invoice ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Date and time the invoice was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the invoice was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Revision number, which increments by 1 each time the invoice is updated.
+     * To prevent conflicting changes,
+     * the current revision must be passed when updating the invoice.
+     *
+     * Ignored when creating a invoice.
+     * @readonly
+     */
+    revision?: string | null;
+    /** Information about the invoice origin. */
+    origin?: BusinessOriginData;
+    /**
+     * Invoice status.
+     *
+     * + `"UNKNOWN"`: There is no information about the invoice status.
+     * + `"OPEN"`: BASS has created the invoice but hasn't initiated the payment process.
+     * + `"PAID"`: The customer has successfully paid for the invoice.
+     * + `"ATTEMPT_FAILED"`: The payment process has started and there has been at least one unsuccessful payment attempt.
+     * + `"FAILED"`: The payment process has failed and there are no more retries.
+     * + `"CANCELED"`: The payment process has been stopped because the related subscription has been canceled.
+     * @readonly
+     */
+    status?: InvoiceStatus;
+    /**
+     * 3-letter currency code of the invoice in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    currency?: string;
+    /** Information about the customer. */
+    customer?: Customer;
+    /**
+     * Whether the payment is processed through Wix and whether the customer must provide some input.
+     *
+     * + `"UNKNOWN"`: There is no information about the collection method.
+     * + `"AUTO_CHARGE"`: The customer pays automatically through Wix.
+     * + `"SEND_INVOICE"`: The customer pays through Wix, but some manual input is required.
+     * + `"OFFLINE"`: The customer pays outside of Wix.
+     */
+    collectionMethod?: CollectionMethod;
+    /**
+     * ID of the
+     * [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.
+     */
+    paymentMethodId?: string | null;
+    /**
+     * Cashier [Order ID](https://dev.wix.com/docs/rest/payments/wix-cashier/pay/order#order-object)
+     * for the corresponding payment.
+     * @readonly
+     */
+    paymentOrderId?: string | null;
+    /** Information about a discount. Available only for invoices that include a discount. */
+    discount?: InvoiceDiscount;
+    /** Billing address. */
+    billingAddress?: FullAddressDetails;
+    /** Shipping address. Available only for `"PHYSICAL"` line items. */
+    shippingAddress?: FullAddressDetails;
+    /** Shipping fee in `0.00` format. */
+    shippingFee?: string | null;
+    /**
+     * Information about the invoice's totals.
+     * @readonly
+     */
+    totals?: Totals;
+    /** Line items belonging to the invoice. */
+    invoiceItems?: InvoiceItem[];
+    /**
+     * Whether the invoice is used to validate payment details.
+     *
+     * + `true`: BASS uses the invoice to test payment details. Relevant for free trials. Ensures that Wix can collect the payment of the first billing cycle.
+     * + `false`: Standard invoice.
+     */
+    isAuthorization?: boolean | null;
+    /** Whether the invoice's `totals.totalPrice` includes tax. */
+    isTaxInclusive?: boolean | null;
+    /** Details of the latest payment attempt. */
+    latestPaymentAttempt?: LatestPaymentAttempt;
+    /** List of charges and credits that adjust the invoice's `totals.totalPrice`. */
+    adjustments?: PriceAdjustment[];
+    /**
+     * Invoice Number.
+     * @readonly
+     */
+    invoiceNumber?: string | null;
+    /**
+     * Shipping charges for the invoice.
+     * Supports only one discount without cycles.
+     * Discounts with cycles (repeated discounts across different billing cycles) are not supported for shipping
+     */
+    shippingCharges?: InvoiceShippingCharges;
+    /** Information about the invoice tax */
+    taxData?: TaxData;
+    /** Business address. */
+    businessAddress?: Address;
+    /** ID of the billing order that created this invoice. */
+    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.
+     */
+    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.
+     */
+    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).
+     */
+    entityId?: string;
+}
+export declare enum InvoiceStatus {
+    UNKNOWN = "UNKNOWN",
+    OPEN = "OPEN",
+    PAID = "PAID",
+    FAILED = "FAILED",
+    ATTEMPT_FAILED = "ATTEMPT_FAILED",
+    CANCELED = "CANCELED"
+}
+export declare enum CollectionMethod {
+    UNKNOWN = "UNKNOWN",
+    AUTO_CHARGE = "AUTO_CHARGE",
+    OFFLINE = "OFFLINE",
+    SEND_INVOICE = "SEND_INVOICE"
+}
+export declare enum CreationMode {
+    UNKNOWN = "UNKNOWN",
+    SYSTEM = "SYSTEM",
+    MANUAL = "MANUAL"
+}
+export interface LatestPaymentAttempt {
+    /**
+     * ID of the latest payment attempt.
+     * @readonly
+     */
+    paymentAttemptId?: string;
+    /**
+     * Date and time of the latest payment attempt in `YYYY-MM-DDThh:mm.sssZ` format.
+     * @readonly
+     */
+    dateAttempt?: Date | null;
+    /** Number of the latest payment attempt. */
+    attemptNumber?: number;
+    /**
+     * Status of the latest payment attempt.
+     *
+     * + `"UNKNOWN"`: There is no information about the status of the latest payment attempt.
+     * + `"SCHEDULED"`:  The latest payment attempt is scheduled but hasn't started yet.
+     * + `"IN_PROGRESS"`: The latest payment attempt is in progress.
+     * + `"PAID"`: The latest payment attempt resulted in a successful payment.
+     * + `"DECLINED"`: The latest payment attempt has been declined.
+     * + `"TECHNICAL_FAILURE"`: The latest payment attempt couldn't be process due to a technical failure.
+     * + `"CANCELED"`: The latest payment attempt has been canceled by BASS.
+     * @readonly
+     */
+    status?: PaymentAttemptStatus;
+    /**
+     * Whether BASS tries to collect the payment another time. Available only when
+     * `latestPaymentAttempt.status` is set to `"DECLINED"`.
+     */
+    retryable?: boolean;
+}
+export declare enum PaymentAttemptStatus {
+    UNKNOWN = "UNKNOWN",
+    SCHEDULED = "SCHEDULED",
+    IN_PROGRESS = "IN_PROGRESS",
+    PAID = "PAID",
+    DECLINED = "DECLINED",
+    TECHNICAL_FAILURE = "TECHNICAL_FAILURE",
+    CANCELED = "CANCELED",
+    PENDING = "PENDING"
+}
+export interface PriceAdjustment extends PriceAdjustmentAdjustmentTypeOneOf {
+    /** Adjustment that increases the price. */
+    charge?: PriceAdjustmentValue;
+    /** Adjustment that lowers the price. */
+    credit?: PriceAdjustmentValue;
+}
+/** @oneof */
+export interface PriceAdjustmentAdjustmentTypeOneOf {
+    /** Adjustment that increases the price. */
+    charge?: PriceAdjustmentValue;
+    /** Adjustment that lowers the price. */
+    credit?: PriceAdjustmentValue;
+}
+export interface PriceAdjustmentValue extends PriceAdjustmentValueAdjustmentValueTypeOneOf {
+    /**
+     * Absolute amount that adjusts the price.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * Relative factor that adjusts the price. For example, setting
+     * `multiplier` to:
+     * - `0.50` results in a price adjustment of 50% of the original value.
+     * - `0.75` results in a price adjustment of 75% of the original value.
+     * - `1.00` results in a price adjustment of 100% of the original value.
+     *
+     * Min: `0.01`
+     * Max: `1.00`
+     */
+    multiplier?: string;
+}
+/** @oneof */
+export interface PriceAdjustmentValueAdjustmentValueTypeOneOf {
+    /**
+     * Absolute amount that adjusts the price.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /**
+     * Relative factor that adjusts the price. For example, setting
+     * `multiplier` to:
+     * - `0.50` results in a price adjustment of 50% of the original value.
+     * - `0.75` results in a price adjustment of 75% of the original value.
+     * - `1.00` results in a price adjustment of 100% of the original value.
+     *
+     * Min: `0.01`
+     * Max: `1.00`
+     */
+    multiplier?: string;
+}
+export interface InvoiceShippingCharges {
+    /**
+     * Amount of the shipping fee in `0.00` format.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /** Tax of the shipping fee */
+    tax?: Tax;
+    /** Information about the shipping charges tax data */
+    taxData?: ItemTaxData;
+    discount?: Discount;
+}
+/** Tax data from all items */
+export interface TaxData {
+    /** Aggregated tax data from all items */
+    taxSummary?: TaxSummary;
+}
+export interface TaxSummary {
+    /** Aggregated from tax_breakdowns with exemptions excluded from amount */
+    aggregatedTaxAmount?: string;
+    /** Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`. */
+    aggregatedTaxBreakdowns?: AggregatedTaxBreakdown[];
+}
+export interface AggregatedTaxBreakdown {
+    /** Name of the tax that was calculated. */
+    taxName?: string;
+    /** Type of tax that was calculated. */
+    taxType?: string;
+    /** Jurisdiction that taxes were calculated for. */
+    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"`. */
+    rate?: string;
+    /** Total amount of this tax for this jurisdiction. */
+    aggregatedTaxAmount?: string;
+}
+export interface Task {
+    key?: TaskKey;
+    executeAt?: Date | null;
+    payload?: string | null;
+}
+export interface TaskKey {
+    appId?: string;
+    instanceId?: string;
+    subjectId?: string | null;
+}
+export interface TaskAction extends TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+/** @oneof */
+export interface TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+export interface Complete {
+}
+export interface Cancel {
+}
+export interface Reschedule {
+    executeAt?: Date | null;
+    payload?: string | null;
+}
+export interface Empty {
+}
+export interface V1SubscriptionEvent extends V1SubscriptionEventEventOneOf {
+    /** A subscriptions was created */
+    created?: V1SubscriptionCreated;
+    /** Subscription is considered active and will be visible to site owners and members */
+    activated?: V1SubscriptionActivated;
+    /**
+     * Subscription was canceled either by cancellation request with requested expiration date NOW or by payment provider.
+     * If cancelled by payment provider subscription will be valid until the date calculated depending on how many cycles it was already paid for.
+     */
+    canceled?: V1SubscriptionCanceled;
+    /** Subscription was updated. Currently the only possible change is valid_until date */
+    updated?: V1SubscriptionUpdated;
+    /** Subscription cycle has started. Currently the cycle starts when a payment is received. */
+    cycleTriggered?: SubscriptionCycleTriggered;
+    /** Offline subscription was marked as paid */
+    markedAsPaid?: SubscriptionMarkedAsPaid;
+    /**
+     * Subscription cancellation for the future date was requested.
+     * Subscription will stay in pending cancellation status until the date calculated depending on free trial and the next payment date.
+     */
+    cancellationRequested?: SubscriptionCancellationRequested;
+    /** Subscription and it's payment schedule (for recurring) was suspended */
+    suspended?: SubscriptionSuspended;
+    /** Previously suspended subscription and it's payment schedule (for recurring) was resumed */
+    resumed?: V1SubscriptionResumed;
+    /** Subscription expired according to valid_until expiration date. */
+    expired?: SubscriptionExpired;
+    /** Subscription initial purchase completed */
+    initialPurchaseCompleted?: V1SubscriptionInitialPurchaseCompleted;
+}
+/** @oneof */
+export interface V1SubscriptionEventEventOneOf {
+    /** A subscriptions was created */
+    created?: V1SubscriptionCreated;
+    /** Subscription is considered active and will be visible to site owners and members */
+    activated?: V1SubscriptionActivated;
+    /**
+     * Subscription was canceled either by cancellation request with requested expiration date NOW or by payment provider.
+     * If cancelled by payment provider subscription will be valid until the date calculated depending on how many cycles it was already paid for.
+     */
+    canceled?: V1SubscriptionCanceled;
+    /** Subscription was updated. Currently the only possible change is valid_until date */
+    updated?: V1SubscriptionUpdated;
+    /** Subscription cycle has started. Currently the cycle starts when a payment is received. */
+    cycleTriggered?: SubscriptionCycleTriggered;
+    /** Offline subscription was marked as paid */
+    markedAsPaid?: SubscriptionMarkedAsPaid;
+    /**
+     * Subscription cancellation for the future date was requested.
+     * Subscription will stay in pending cancellation status until the date calculated depending on free trial and the next payment date.
+     */
+    cancellationRequested?: SubscriptionCancellationRequested;
+    /** Subscription and it's payment schedule (for recurring) was suspended */
+    suspended?: SubscriptionSuspended;
+    /** Previously suspended subscription and it's payment schedule (for recurring) was resumed */
+    resumed?: V1SubscriptionResumed;
+    /** Subscription expired according to valid_until expiration date. */
+    expired?: SubscriptionExpired;
+    /** Subscription initial purchase completed */
+    initialPurchaseCompleted?: V1SubscriptionInitialPurchaseCompleted;
+}
+export interface V1SubscriptionCreated {
+    subscription?: V1Subscription;
+}
+export interface V1Subscription {
+    /**
+     * ID of the subscription
+     * @readonly
+     */
+    _id?: string;
+    /** ID of the app which created the subscription */
+    wixAppId?: string;
+    /** Instance ID of the Subscriptions app */
+    tenantId?: string;
+    /** ID of entity in app (e.g. a cart in stores/order in paid plans) */
+    originEntityId?: string;
+    /** Site member or a contact who bought the subscription */
+    subscriber?: Subscriber;
+    /** Wix Pay order ID, is empty for free subscriptions */
+    wixPayOrderId?: string | null;
+    /** Subscription name (e.g. a product or subscription package name) */
+    name?: string;
+    /** Optional additional subscription description */
+    description?: string;
+    /** Amount to be paid for a single scheduled payment */
+    price?: Money;
+    /** True if the subscription is recurring, false for a single payment subscription */
+    recurring?: boolean;
+    /** Online (paid by subscriber using wix pay) or offline (need to manually mark as paid) */
+    subscriptionType?: SubscriptionType;
+    /** Active, expired, canceled, etc. */
+    subscriptionStatus?: V1SubscriptionStatusEnumSubscriptionStatus;
+    /** Subscription start date (may differ from creation date) */
+    validFrom?: Date | null;
+    /** Subscription expiration date */
+    validUntil?: Date | null;
+    /** Status of last payment associated with this subscription */
+    lastPaymentStatus?: PaymentStatusEnumPaymentStatus;
+    /** Payment schedule in the wix pay format. Exists for recurring subscriptions only. */
+    billingProfile?: V2Subscription;
+    /** Owner, member, etc. - present if subscription is canceled */
+    cancellationInitiator?: CancellationInitiator;
+    /** Optional, present if subscription is canceled */
+    cancellationReason?: string | null;
+    /** Can be used for arbitrary app-specific map<string, string> data */
+    externalData?: Record<string, string>;
+    /** Date when subscription was created (not related to payment dates) */
+    dateCreated?: Date | null;
+    /** Restrictions on possible subscription actions. Default policy has all restrictions enabled. */
+    policy?: SubscriptionPolicy;
+    /** List of subscription suspension periods */
+    suspensions?: Suspension[];
+    /** Initial subscription expiration date that was calculated on the subscription purchase plus duration of suspensions */
+    validUntilDateWithSuspensions?: Date | null;
+    /** Duration of single payment subscription (instead of billing_profile) */
+    singlePaymentDuration?: V1Duration;
+    originInstanceId?: string | null;
+}
+export interface Subscriber {
+    /** Member or contact ID */
+    _id?: string;
+    /** Member or contact */
+    identityType?: IdentityType;
+}
+export declare enum IdentityType {
+    /** Identity type undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Subscription is associated with a member ID */
+    MEMBER = "MEMBER",
+    /** Subscriptions is associated with a contact ID */
+    CONTACT = "CONTACT"
+}
+/** Price of a payment. Includes amount and currency. */
+export interface Money {
+    /** Monetary amount i.e. 3.99. */
+    amount?: string;
+    /** Currency in ISO 4217 format i.e. USD. */
+    currency?: string;
+}
+export declare enum SubscriptionType {
+    UNDEFINED = "UNDEFINED",
+    /** Payments made by the subscriber */
+    ONLINE = "ONLINE",
+    /** Payments managed manually by the site owner */
+    OFFLINE = "OFFLINE"
+}
+export declare enum V1SubscriptionStatusEnumSubscriptionStatus {
+    /** Subscription status undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Subscription created, but hasn't been paid for yet. This status if filtered out in ListSubscriptions response by default. */
+    DRAFT = "DRAFT",
+    /** Subscription has been paid for, but the start date is in the future */
+    PENDING = "PENDING",
+    /** Subscription is active */
+    ACTIVE = "ACTIVE",
+    /** Subscription has expired */
+    EXPIRED = "EXPIRED",
+    /** Subscription has been canceled */
+    CANCELED = "CANCELED",
+    /** Subscription has been set to be canceled at a future date */
+    PENDING_CANCELLATION = "PENDING_CANCELLATION",
+    /** Subscription is suspended */
+    SUSPENDED = "SUSPENDED"
+}
+export declare enum PaymentStatusEnumPaymentStatus {
+    /** Payment status undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Payment has been paid */
+    PAID = "PAID",
+    /** Payment has been refunded */
+    REFUNDED = "REFUNDED",
+    /** Recurring payment has failed */
+    FAILED = "FAILED",
+    /** Payment has not been paid */
+    UNPAID = "UNPAID",
+    /** Billing has been initialized, but actual charge is yet to be made. Can happen for free trial and PayPal */
+    PENDING = "PENDING"
+}
+/**
+ * Recurring payment is described by `frequency` (day, week, month) and `interval`.
+ *
+ * For example, to create a recurring payment every 14 days, just set `interval` to 14 and frequency to `DAY`.
+ *
+ * In some cases there should be a trial period for the order, after which payments start to occur.
+ * Trial period is also defined as `frequency` and `interval` pair.
+ *
+ * So one can define a monthly 'subscription' with a 14 days trial period.
+ */
+export interface V2Subscription {
+    /** frequency of recurring payment (required) */
+    frequency?: SubscriptionFrequency;
+    /** interval of recurring payment (required) */
+    interval?: number;
+    /** trial period for recurring payment (optional) */
+    trial?: SubscriptionTrialPeriod;
+    /**
+     * how many billing cycles should be done before subscription finishes
+     * (optional, 0 by default means endless subscription)
+     */
+    billingCycles?: number;
+    /**
+     * date in the future or in the past when the first billing cycle begins
+     * (the first off-session payment is performed when it ends)
+     */
+    firstCycleStartDate?: Date | null;
+}
+/** Frequency unit of recurring payment */
+export declare enum SubscriptionFrequency {
+    UNDEFINED = "UNDEFINED",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+/** Trial period of subscription */
+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;
+}
+export interface GetSubscriptionInvoicesRequest {
+    _id?: string;
+}
+export interface GetSubscriptionInvoicesResponse {
+    invoices?: SubscriptionInvoice[];
+}
+export interface SubscriptionInvoice {
+    _id?: string;
+    subscriptionCycle?: number;
+    _createdDate?: Date | null;
+}
+export interface FinishFreeTrialNowRequest {
+    subscriptionId?: string;
+    tenantId?: string;
+}
+export interface FinishFreeTrialNowResponse {
+    subscription?: Subscription;
+}
+export interface SendTimeCapsuleTaskCanceledBIRequest {
+    tenantId?: string;
+    subscriptionId?: string;
+    taskType?: string;
+}
+export interface ScheduleTimeCapsuleTaskRequest {
+    subscriptionId?: string;
+    taskType?: string;
+    executionTime?: Date | null;
+    tenantId?: string;
+}
+export interface CancelTimeCapsuleTaskRequest {
+    tenantId?: string;
+    subscriptionId?: string;
+    taskType?: string;
+}
+export interface UpdateFullSubscriptionRequest {
+    tenantId?: string;
+    subscription?: Subscription;
+}
+export interface UpdateFullSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface UpdateSubscriptionInvoiceCycleRequest {
+    subscriptionId?: string;
+    tenantId?: string;
+    invoiceId?: string;
+    subscriptionCycle?: number;
+}
+export interface UpdateSubscriptionInvoiceCycleResponse {
+    subscriptionInvoice?: SubscriptionInvoice;
+}
+export interface AddPausePeriodRequest {
+    tenantId?: string;
+    subscriptionId?: string;
+    pauseStartDate?: Date | null;
+    pauseEndDate?: Date | null;
+}
+export interface AddPausePeriodResponse {
+    subscription?: Subscription;
+}
+export interface RunTimeCapsuleTaskNowRequest {
+    tenantId?: string;
+    subscriptionId?: string;
+    taskType?: string;
+}
+export interface CreateRecurringInvoiceBORequest {
+    subscriptionId?: string;
+    tenantId?: string;
+    cycleNumber?: number;
+}
+export interface CreateRecurringInvoiceBOResponse {
+    invoiceId?: string;
+}
+export interface SetShiftingDataRequest {
+    subscriptionId?: string;
+    tenantId?: string;
+    isBassManaged?: boolean;
+    shiftManagementDate?: Date | null;
+}
+export interface SetShiftingDataResponse {
+    subscription?: Subscription;
+}
+export interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
+    attachInvoice?: AttachInvoice;
+    detachInvoice?: DetachInvoice;
+    tenantId?: string;
+    subscriptionId?: string;
+}
+/** @oneof */
+export interface FixSubscriptionInvoicesRequestModeOneOf {
+    attachInvoice?: AttachInvoice;
+    detachInvoice?: DetachInvoice;
+}
+export interface AttachInvoice {
+    invoiceId?: string;
+}
+export interface DetachInvoice {
+    invoiceId?: string;
+}
+export interface FixSubscriptionInvoicesResponse {
+    invoices?: SubscriptionInvoice[];
+}
+export interface RestoreDraftSubscriptionRequest {
+    tenantId?: string;
+    subscriptionId?: string;
+}
+export interface RestoreDraftSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface DeleteDraftSubscriptionRequest {
+    tenantId?: string;
+    subscriptionId?: string;
+}
+export interface DeleteDraftSubscriptionResponse {
+    subscription?: Subscription;
+}
+export interface DeleteSubscriptionBORequest {
+    tenantId?: string;
+    subscriptionId?: string;
+}
+export interface DeleteSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+export interface CancelSubscriptionBORequest {
+    tenantId?: string;
+    subscriptionId?: string;
+    initiator?: ActionInitiator;
+    reason?: string | null;
+}
+export interface CancelSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+export interface UpdatePaymentMethodBORequest {
+    tenantId?: string;
+    subscriptionId?: string;
+    paymentMethodId?: string;
+}
+export interface UpdatePaymentMethodBOResponse {
+    subscription?: Subscription;
+}
+export interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+    tenantId?: string;
+    subscriptionId?: string;
+}
+/** @oneof */
+export interface SendSubscriptionActionEventBORequestEventOneOf {
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+}
+export interface SendSubscriptionActionEventResponse {
+}
+export interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
+    tenantId?: string;
+    subscriptionId?: string;
+    transactionId?: string;
+}
+export interface PauseSubscriptionBORequest {
+    tenantId?: string;
+    subscriptionId?: string;
+    pausePolicy?: PausePolicy;
+    pauseAt?: PauseAt;
+    initiator?: ActionInitiator;
+    reason?: string | null;
+}
+export interface PauseSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+interface CustomerNonNullableFields {
+    visitorId: string;
+    contactId: string;
+    memberId: string;
+    accountId: string;
+}
+interface PaymentMethodNonNullableFields {
+    _id: string;
+}
+interface DurationNonNullableFields {
+    unit: DurationUnit;
+}
+interface StreetAddressNonNullableFields {
+    number: string;
+    name: string;
+}
+interface AddressNonNullableFields {
+    streetAddress?: StreetAddressNonNullableFields;
+}
+interface FullAddressDetailsNonNullableFields {
+    address?: AddressNonNullableFields;
+}
+interface TaxSettingsNonNullableFields {
+    inclusive: boolean;
+}
+interface DynamicTaxNonNullableFields {
+    taxableAddressType: TaxableAddressType;
+}
+interface TaxNonNullableFields {
+    amount: string;
+    percentage: string;
+    dynamic?: DynamicTaxNonNullableFields;
+}
+interface CyclesNonNullableFields {
+    cycleFrom: number;
+}
+interface OriginNonNullableFields {
+    appId: string;
+    entityId: string;
+}
+interface AdditionalFeeNonNullableFields {
+    name: string;
+    amount: string;
+    trigger: AdditionalFeeTrigger;
+    tax?: TaxNonNullableFields;
+    cycles?: CyclesNonNullableFields;
+    origin?: OriginNonNullableFields;
+}
+interface DiscountCyclesNonNullableFields {
+    cycleFrom: number;
+}
+interface DiscountOriginNonNullableFields {
+    appId: string;
+    entityId: string;
+}
+interface DiscountNonNullableFields {
+    amount: string;
+    percentage: string;
+    cycles?: DiscountCyclesNonNullableFields;
+    origin?: DiscountOriginNonNullableFields;
+}
+interface ShippingChargesNonNullableFields {
+    amount: string;
+    tax?: TaxNonNullableFields;
+    discounts: DiscountNonNullableFields[];
+}
+interface ExternalCollectionDetailsNonNullableFields {
+    collectorName: string;
+}
+interface BillingSettingsNonNullableFields {
+    currency: string;
+    paymentMethod?: PaymentMethodNonNullableFields;
+    collectionMethod: CollectionMethodEnumCollectionMethod;
+    cycleDuration?: DurationNonNullableFields;
+    cycleAutoRenew: boolean;
+    freeTrialDuration?: DurationNonNullableFields;
+    billingAddress?: FullAddressDetailsNonNullableFields;
+    taxSettings?: TaxSettingsNonNullableFields;
+    additionalFees: AdditionalFeeNonNullableFields[];
+    shippingCharges?: ShippingChargesNonNullableFields;
+    discounts: DiscountNonNullableFields[];
+    externalCollectionDetails?: ExternalCollectionDetailsNonNullableFields;
+}
+interface TotalsNonNullableFields {
+    totalPrice: string;
+    subtotal: string;
+}
+interface PaymentDataNonNullableFields {
+    invoiceId: string;
+    paymentStatus: PaymentStatus;
+    totals?: TotalsNonNullableFields;
+}
+interface CustomProrationNonNullableFields {
+    charge: string;
+    credit: string;
+}
+interface ProrationNonNullableFields {
+    custom?: CustomProrationNonNullableFields;
+}
+interface UpdateBillingDateDataNonNullableFields {
+    proration?: ProrationNonNullableFields;
+}
+interface AutomaticRetryDataNonNullableFields {
+    enabled: boolean;
+}
+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[];
+}
+interface SubscriptionCreatedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface SubscriptionUpdatedNonNullableFields {
+    current?: SubscriptionNonNullableFields;
+    previous?: SubscriptionNonNullableFields;
+}
+interface SubscriptionDeletedNonNullableFields {
+    subscriptionId: string;
+}
+interface SubscriptionActivatedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface SubscriptionEndedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface ActionDetailsNonNullableFields {
+    initiator: HistoryActionInitiator;
+}
+interface SubscriptionCanceledNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface SubscriptionPausedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    pausePolicy: PausePolicy;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface SubscriptionResumedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface PauseSubscriptionRequestedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    pauseAt: PauseAt;
+    pausePolicy: PausePolicy;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface ResumeSubscriptionRequestedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    resumeAt: ResumeAt;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface ScheduledPauseCanceledNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface ScheduledResumeCanceledNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface SubscriptionBillingCycleStartedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface SubscriptionAutoRenewalTurnedOnNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface SubscriptionAutoRenewalTurnedOffNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface SubscriptionCycleReadyToPayNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface SubscriptionExtendedNonNullableFields {
+    extensionPeriod?: DurationNonNullableFields;
+    extensionBillingCycles: number;
+    subscription?: SubscriptionNonNullableFields;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface SubscriptionInitialPurchaseCompletedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    actionDetails?: ActionDetailsNonNullableFields;
+}
+interface LatestInvoiceMarkedAsPaidNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface SubscriptionRevivedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface SubscriptionBillingDateUpdatedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    proration?: ProrationNonNullableFields;
+}
+interface FutureUpdatesRequestedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    requestedUpdateData?: SubscriptionUpdateDataNonNullableFields;
+}
+interface UpdatesAppliedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    updateAction: UpdateAction;
+    appliedUpdateData?: SubscriptionUpdateDataNonNullableFields;
+}
+interface ResetPendingUpdatesNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface GracePeriodStartedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface GracePeriodEndedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    paymentSettlementMethod: PaymentSettlementMethod;
+}
+interface PaymentMethodUpdatedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    initiator: HistoryActionInitiator;
+    paymentMode: PaymentMode;
+}
+interface SubscriptionCollectionMethodUpdatedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    newCollectionMethod: CollectionMethodEnumCollectionMethod;
+    previousCollectionMethod: CollectionMethodEnumCollectionMethod;
+}
+interface FreeTrailStartedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface FreeTrailEndedNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface InvoiceMarkedAsPaidNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    paidCycle: number;
+    invoiceId: string;
+}
+interface InitiatedPaymentMethodSetupNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+}
+interface SubscriptionBackOfficeActionNonNullableFields {
+    subscription?: SubscriptionNonNullableFields;
+    name: string;
+    params: string;
+}
+interface SubscriptionEventNonNullableFields {
+    created?: SubscriptionCreatedNonNullableFields;
+    updated?: SubscriptionUpdatedNonNullableFields;
+    deleted?: SubscriptionDeletedNonNullableFields;
+    activated?: SubscriptionActivatedNonNullableFields;
+    ended?: SubscriptionEndedNonNullableFields;
+    canceled?: SubscriptionCanceledNonNullableFields;
+    paused?: SubscriptionPausedNonNullableFields;
+    resumed?: SubscriptionResumedNonNullableFields;
+    pauseRequested?: PauseSubscriptionRequestedNonNullableFields;
+    resumeRequested?: ResumeSubscriptionRequestedNonNullableFields;
+    scheduledPauseCanceled?: ScheduledPauseCanceledNonNullableFields;
+    scheduledResumeCanceled?: ScheduledResumeCanceledNonNullableFields;
+    billingCycleStarted?: SubscriptionBillingCycleStartedNonNullableFields;
+    autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOnNonNullableFields;
+    autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOffNonNullableFields;
+    cycleReadyToPay?: SubscriptionCycleReadyToPayNonNullableFields;
+    extended?: SubscriptionExtendedNonNullableFields;
+    initialPurchaseCompleted?: SubscriptionInitialPurchaseCompletedNonNullableFields;
+    latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaidNonNullableFields;
+    revived?: SubscriptionRevivedNonNullableFields;
+    billingDateUpdated?: SubscriptionBillingDateUpdatedNonNullableFields;
+    futureUpdatesRequested?: FutureUpdatesRequestedNonNullableFields;
+    updatesApplied?: UpdatesAppliedNonNullableFields;
+    resetPendingUpdates?: ResetPendingUpdatesNonNullableFields;
+    gracePeriodStarted?: GracePeriodStartedNonNullableFields;
+    gracePeriodEnded?: GracePeriodEndedNonNullableFields;
+    paymentMethodUpdated?: PaymentMethodUpdatedNonNullableFields;
+    collectionMethodUpdated?: SubscriptionCollectionMethodUpdatedNonNullableFields;
+    freeTrailStarted?: FreeTrailStartedNonNullableFields;
+    freeTrailEnded?: FreeTrailEndedNonNullableFields;
+    invoiceMarkedAsPaid?: InvoiceMarkedAsPaidNonNullableFields;
+    initiatePaymentMethodSetup?: InitiatedPaymentMethodSetupNonNullableFields;
+    subscriptionBoAction?: SubscriptionBackOfficeActionNonNullableFields;
+}
+interface SubscriptionHistoryEntryNonNullableFields {
+    entryId: string;
+    slug: string;
+    event?: SubscriptionEventNonNullableFields;
+}
+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 interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * 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
+     */
+    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 SubscriptionCanceledEnvelope {
+    data: SubscriptionCanceled;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription is canceled.
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_canceled
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionCanceled(handler: (event: SubscriptionCanceledEnvelope) => void | Promise<void>): void;
+export interface SubscriptionExtendedEnvelope {
+    data: SubscriptionExtended;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when subscription has been extended
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_extended
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionExtended(handler: (event: SubscriptionExtendedEnvelope) => void | Promise<void>): void;
+export interface SubscriptionUpdatedEnvelope {
+    entity: Subscription;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription is updated.
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_updated
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionUpdated(handler: (event: SubscriptionUpdatedEnvelope) => void | Promise<void>): void;
+export interface SubscriptionAutoRenewalTurnedOffEnvelope {
+    data: SubscriptionAutoRenewalTurnedOff;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription cycleAutoRenew was turned off.
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_auto_renewal_turned_off
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionAutoRenewalTurnedOff(handler: (event: SubscriptionAutoRenewalTurnedOffEnvelope) => void | Promise<void>): void;
+export interface SubscriptionAutoRenewalTurnedOnEnvelope {
+    data: SubscriptionAutoRenewalTurnedOn;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription cycleAutoRenew was turned on.
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_auto_renewal_turned_on
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionAutoRenewalTurnedOn(handler: (event: SubscriptionAutoRenewalTurnedOnEnvelope) => void | Promise<void>): void;
+export interface SubscriptionBillingDateUpdatedEnvelope {
+    data: SubscriptionBillingDateUpdated;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when subscription has been extended
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_billing_date_updated
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionBillingDateUpdated(handler: (event: SubscriptionBillingDateUpdatedEnvelope) => void | Promise<void>): void;
+export interface SubscriptionLatestInvoiceMarkedAsPaidEnvelope {
+    data: LatestInvoiceMarkedAsPaid;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_latest_invoice_marked_as_paid
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionLatestInvoiceMarkedAsPaid(handler: (event: SubscriptionLatestInvoiceMarkedAsPaidEnvelope) => void | Promise<void>): void;
+export interface SubscriptionPauseScheduleCanceledEnvelope {
+    data: ScheduledPauseCanceled;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when scheduled pause canceled
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_pause_schedule_canceled
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionPauseScheduleCanceled(handler: (event: SubscriptionPauseScheduleCanceledEnvelope) => void | Promise<void>): void;
+export interface SubscriptionPauseScheduledEnvelope {
+    data: PauseSubscriptionRequested;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when pause subscription requested
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_pause_scheduled
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionPauseScheduled(handler: (event: SubscriptionPauseScheduledEnvelope) => void | Promise<void>): void;
+export interface SubscriptionPausedEnvelope {
+    data: SubscriptionPaused;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription is paused.
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_paused
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionPaused(handler: (event: SubscriptionPausedEnvelope) => void | Promise<void>): void;
+export interface SubscriptionResumeScheduleCanceledEnvelope {
+    data: ScheduledResumeCanceled;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when scheduled pause canceled
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_resume_schedule_canceled
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionResumeScheduleCanceled(handler: (event: SubscriptionResumeScheduleCanceledEnvelope) => void | Promise<void>): void;
+export interface SubscriptionResumeScheduledEnvelope {
+    data: ResumeSubscriptionRequested;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when resume subscription requested
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_resume_scheduled
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionResumeScheduled(handler: (event: SubscriptionResumeScheduledEnvelope) => void | Promise<void>): void;
+export interface SubscriptionResumedEnvelope {
+    data: SubscriptionResumed;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription is resumed.
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_resumed
+ * @documentationMaturity preview
+ */
+export declare function onSubscriptionResumed(handler: (event: SubscriptionResumedEnvelope) => void | Promise<void>): void;
+/** @public
+ * @documentationMaturity preview
+ * @requiredField subscriptionId
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionHistoryService.ListSubscriptionHistory
+ */
+export declare function listSubscriptionHistory(subscriptionId: string, options?: ListSubscriptionHistoryOptions): Promise<ListSubscriptionHistoryResponse & ListSubscriptionHistoryResponseNonNullableFields>;
+export interface ListSubscriptionHistoryOptions {
+    /** 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;
+}
+/**
+ * Identity must be a site member and customer subscription belongs to
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.GetSubscription
+ */
+export declare function customerGetSubscription(_id: string): Promise<GetSubscriptionResponse & GetSubscriptionResponseNonNullableFields>;
+/**
+ * Identity must be a site member and customer subscription belongs to
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.CancelSubscription
+ */
+export declare function customerCancelSubscription(_id: string, options?: CustomerCancelSubscriptionOptions): Promise<CustomerCancelSubscriptionResponse & CustomerCancelSubscriptionResponseNonNullableFields>;
+export interface CustomerCancelSubscriptionOptions {
+    /** Optional action reason message */
+    reason?: string | null;
+}
+/**
+ * Identity must be a site member and customer subscription belongs to
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.TurnOnSubscriptionAutoRenewal
+ */
+export declare function customerTurnOnSubscriptionAutoRenewal(_id: string, options?: CustomerTurnOnSubscriptionAutoRenewalOptions): Promise<CustomerTurnOnAutoRenewalResponse & CustomerTurnOnAutoRenewalResponseNonNullableFields>;
+export interface CustomerTurnOnSubscriptionAutoRenewalOptions {
+    /** Optional action reason message */
+    reason?: string | null;
+}
+/**
+ * Identity must be a site member and customer subscription belongs to
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.TurnOffSubscriptionAutoRenewal
+ */
+export declare function customerTurnOffSubscriptionAutoRenewal(_id: string, options?: CustomerTurnOffSubscriptionAutoRenewalOptions): Promise<CustomerTurnOffAutoRenewalResponse & CustomerTurnOffAutoRenewalResponseNonNullableFields>;
+export interface CustomerTurnOffSubscriptionAutoRenewalOptions {
+    /** Optional action reason message */
+    reason?: string | null;
+}
+/** @param _id - The ID of the subscription to be extended
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField options.billingCyclesToAdd
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.ExtendSubscription
+ */
+export declare function customerExtendSubscription(_id: string, options?: CustomerExtendSubscriptionOptions): Promise<CustomerExtendSubscriptionResponse & CustomerExtendSubscriptionResponseNonNullableFields>;
+export interface CustomerExtendSubscriptionOptions {
+    /** 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;
+}
+/**
+ * identity must be a site member
+ * @public
+ * @documentationMaturity preview
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.QuerySubscriptions
+ */
+export declare function customerQuerySubscriptions(options?: CustomerQuerySubscriptionsOptions): Promise<QuerySubscriptionsResponse & QuerySubscriptionsResponseNonNullableFields>;
+export interface CustomerQuerySubscriptionsOptions {
+    query?: QueryV2;
+}
+/**
+ * Update subscription's payment method.
+ * Supported only for recurring subscriptions or one time subscriptions during free trial.
+ * @param _id - Subscription ID
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField paymentMethodId
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.UpdateSubscriptionPaymentMethod
+ */
+export declare function customerUpdateSubscriptionPaymentMethod(_id: string, paymentMethodId: string): Promise<UpdateSubscriptionPaymentMethodResponse & UpdateSubscriptionPaymentMethodResponseNonNullableFields>;
+/** @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.AllowedActions
+ */
+export declare function customerAllowedActions(_id: string): Promise<CustomerAllowedActionsResponse & CustomerAllowedActionsResponseNonNullableFields>;
+/**
+ * List future subscriptions charges.
+ * @param _id - Subscription id upcoming charge to be previewed for
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.ListUpcomingCharges
+ */
+export declare function customerListUpcomingCharges(_id: string): Promise<CustomerListUpcomingChargesResponse & CustomerListUpcomingChargesResponseNonNullableFields>;
+/**
+ * Creates auto-charge order that can be paid by customer
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.InitiatePaymentMethodSetup
+ */
+export declare function customerInitiatePaymentMethodSetup(_id: string, options?: CustomerInitiatePaymentMethodSetupOptions): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
+export interface CustomerInitiatePaymentMethodSetupOptions {
+    paymentMode?: PaymentMode;
+    paymentSettings?: PaymentSettings;
+}
+/**
+ * Returns a single subscription by its id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.GetSubscription
+ */
+export declare function getSubscription(_id: string): Promise<GetSubscriptionResponse & GetSubscriptionResponseNonNullableFields>;
+/**
+ * Update subscription's payment method.
+ * Supported only for recurring subscriptions or one time subscriptions during free trial.
+ * @param _id - Subscription ID
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField paymentMethodId
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.UpdateSubscriptionPaymentMethod
+ */
+export declare function updateSubscriptionPaymentMethod(_id: string, paymentMethodId: string): Promise<UpdateSubscriptionPaymentMethodResponse & UpdateSubscriptionPaymentMethodResponseNonNullableFields>;
+/**
+ * Updates the next billing date for a subscription.
+ *
+ *
+ * Updating the billing date may add a proration charge or credit to the next
+ * invoice. The customer must pay more in case you extend the current billing
+ * cycle. They pay less in case you shorten the current billing cycle. You can
+ * choose whether BASS automatically calculates the proration amount based on
+ * the number of days added to or removed from the current billing cycle.
+ * Alternatively, you can pass a proration amount based on your own custom
+ * calculation. The custom proration amount can't exceed the total of the
+ * current billing cycle.
+ * @param _id - ID of the subscription to update the billing date for.
+ * @param billingDate - New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField billingDate
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.UpdateSubscriptionBillingDate
+ */
+export declare function updateSubscriptionBillingDate(_id: string, billingDate: Date | null, options?: UpdateSubscriptionBillingDateOptions): Promise<UpdateSubscriptionBillingDateResponse & UpdateSubscriptionBillingDateResponseNonNullableFields>;
+export interface UpdateSubscriptionBillingDateOptions {
+    /**
+     * 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;
+}
+/**
+ * Cancels subscription immediately. Can be canceled by member if subscription policy allows it
+ * Only PENDING, ACTIVE or PAUSED subscriptions can be canceled
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField actionContext
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.CancelSubscription
+ */
+export declare function cancelSubscription(_id: string, actionContext: ActionContext): Promise<CancelSubscriptionResponse & CancelSubscriptionResponseNonNullableFields>;
+/**
+ * Pauses subscription now or in future. Possible to pause also payments schedule.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField options.actionContext
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.PauseSubscription
+ */
+export declare function pauseSubscription(_id: string, options?: PauseSubscriptionOptions): Promise<PauseSubscriptionResponse & PauseSubscriptionResponseNonNullableFields>;
+export interface PauseSubscriptionOptions {
+    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;
+}
+/**
+ * Resumes paused subscription now or in future.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField options.actionContext
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.ResumeSubscription
+ */
+export declare function resumeSubscription(_id: string, options?: ResumeSubscriptionOptions): Promise<ResumeSubscriptionResponse & ResumeSubscriptionResponseNonNullableFields>;
+export interface ResumeSubscriptionOptions {
+    resumeAt?: ResumeAt;
+    /** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
+    resumeAtSchedule?: ScheduleAdditionalInfo;
+    actionContext: ActionContext;
+}
+/**
+ * Lists subscriptions based on specified filters.
+ * By default non-draft subscriptions returned.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField query
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.QuerySubscriptions
+ */
+export declare function querySubscriptions(query: QueryV2): Promise<QuerySubscriptionsResponse & QuerySubscriptionsResponseNonNullableFields>;
+/** @public
+ * @documentationMaturity preview
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.SearchSubscriptions
+ */
+export declare function searchSubscriptions(options?: SearchSubscriptionsOptions): Promise<SearchSubscriptionsResponse & SearchSubscriptionsResponseNonNullableFields>;
+export interface SearchSubscriptionsOptions extends SearchSubscriptionsRequestPagingMethodOneOf {
+    /** A filter object */
+    filter?: any;
+    /** 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 Sorting option by field name and order. */
+    sorting?: SortingClauses;
+}
+/**
+ * Counts subscriptions given the provided filters. Returns the total number
+ * of subscriptions matching the filters and a count per status.
+ *
+ *
+ * You can either pass a list of statuses or a `statusGroup`, which is a
+ * pre-defined combination of statuses.
+ *
+ * If you don't provide any filters, all subscription statuses with the
+ * exception of `"DRAFT"` are counted.
+ *
+ * You may also specify a `customerId` as filter. Then, only subscriptions for
+ * this customer are counted. When providing a `customerId`, you must also
+ * specify a `paymentMethodId`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.CountSubscriptions
+ */
+export declare function countSubscriptions(options?: CountSubscriptionsOptions): Promise<CountSubscriptionsResponse & CountSubscriptionsResponseNonNullableFields>;
+export interface CountSubscriptionsOptions {
+    /** Filters to specify which subscriptions are counted. */
+    filter?: CountSubscriptionFilter;
+}
+/**
+ * Turn on auto-renew subscription in case auto-renew was turned off. The operation changes back cycle_auto_renew
+ * to true, which will ensure subscription billing will continue. Also cancellation info holding information about
+ * auto renew off will be cleared.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField actionContext
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.TurnOnSubscriptionAutoRenewal
+ */
+export declare function turnOnSubscriptionAutoRenewal(_id: string, actionContext: ActionContext): Promise<TurnOnSubscriptionAutoRenewalResponse & TurnOnSubscriptionAutoRenewalResponseNonNullableFields>;
+/**
+ * Turn off auto-renew of subscription. At next billing date subscription will be canceled.
+ * Billing settings flag cycle_auto_renew is set to false and information about this operation stored
+ * in cancellation info for future usage in cancellation.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField actionContext
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.TurnOffSubscriptionAutoRenewal
+ */
+export declare function turnOffSubscriptionAutoRenewal(_id: string, actionContext: ActionContext): Promise<TurnOffSubscriptionAutoRenewalResponse & TurnOffSubscriptionAutoRenewalResponseNonNullableFields>;
+/**
+ * Marks the last invoice as paid used for the following scenarios:
+ * * Offline subscriptions.
+ * * Online subscriptions during grace period. The operation will convert invoice to offline, remove grace period
+ * and will send BillingCycleStarted event after invoice closing.
+ * * Online one time payment subscription with total price of zero during purchase flow.
+ * Activated event will be sent after invoice closing and subscription will be activated.
+ * @param subscriptionId - The ID of the offline subscription to mark as paid its latest invoice
+ * @public
+ * @documentationMaturity preview
+ * @requiredField subscriptionId
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.MarkLatestInvoiceAsPaid
+ * @deprecated
+ * @replacedBy com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.MarkInvoiceAsPaid
+ * @targetRemovalDate 2025-09-30
+ */
+export declare function markLatestInvoiceAsPaid(subscriptionId: string): Promise<MarkLatestInvoiceAsPaidResponse & MarkLatestInvoiceAsPaidResponseNonNullableFields>;
+/**
+ * Marks the invoice associated with the subscription in the specified cycle as paid.
+ * If `paid_cycle` is left empty, the most recent invoice will be marked as paid.
+ * If the invoice contains items other than subscription items, an error will be thrown.
+ *
+ * Marks the invoice as paid for the following scenarios:
+ * 1. Offline subscriptions.
+ * 2. Online subscriptions during the grace period.
+ * This operation will convert the invoice to offline, remove the grace period,
+ * and send a BillingCycleStarted event after the invoice is closed.
+ * 3. Online one-time payment subscriptions with a total price of zero during the purchase flow.
+ * An Activated event will be sent after the invoice is closed, and the subscription will be activated.
+ * 4. For external subscriptions, where the payment occurs outside of BASS, an invoice is created and marked as paid
+ * @param subscriptionId - The ID of the subscription to mark as paid its invoice.
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField subscriptionId
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.MarkInvoiceAsPaid
+ */
+export declare function markInvoiceAsPaid(subscriptionId: string, options?: MarkInvoiceAsPaidOptions): Promise<MarkInvoiceAsPaidResponse & MarkInvoiceAsPaidResponseNonNullableFields>;
+export interface MarkInvoiceAsPaidOptions {
+    /**
+     * 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;
+}
+/**
+ * Returns number of subscriptions in each state.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.GetSubscriptionsStats
+ */
+export declare function getSubscriptionsStats(): Promise<GetSubscriptionsStatsResponse & GetSubscriptionsStatsResponseNonNullableFields>;
+/**
+ * Extends subscription by moving end date with or without billing cycles addition.
+ * @param _id - The ID of the subscription to be extended
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField actionContext
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.ExtendSubscription
+ */
+export declare function extendSubscription(_id: string, actionContext: ActionContext, options?: ExtendSubscriptionOptions): Promise<ExtendSubscriptionResponse & ExtendSubscriptionResponseNonNullableFields>;
+export interface ExtendSubscriptionOptions 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;
+}
+/** @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.AllowedActions
+ */
+export declare function allowedActions(_id: string, options?: AllowedActionsOptions): Promise<AllowedActionsResponse & AllowedActionsResponseNonNullableFields>;
+export interface AllowedActionsOptions {
+    /** List of additional fields to be included in the response. */
+    fields?: RequestedFields[];
+}
+/**
+ * List future subscriptions charges
+ * @param subscriptionId - Subscription id charges to be previewed for
+ * @public
+ * @documentationMaturity preview
+ * @requiredField subscriptionId
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.ListUpcomingCharges
+ */
+export declare function listUpcomingCharges(subscriptionId: string, options?: ListUpcomingChargesOptions): Promise<ListUpcomingChargesResponse & ListUpcomingChargesResponseNonNullableFields>;
+export interface ListUpcomingChargesOptions {
+    /** 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;
+}
+/**
+ * Retrieves the preview of subscription charges.
+ * Returns all the charges applicable to a subscription based on the provided subscription information.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options
+ * @requiredField options.subscriptionInfo
+ * @requiredField options.subscriptionInfo.billingSettings
+ * @requiredField options.subscriptionInfo.items
+ * @requiredField options.subscriptionInfo.items.pricingModel
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.PreviewSubscriptionCharges
+ * @deprecated
+ * @replacedBy com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.PreviewSubscriptionsCharges
+ * @targetRemovalDate 2025-06-30
+ */
+export declare function previewSubscriptionCharges(options: PreviewSubscriptionChargesOptions): Promise<PreviewSubscriptionChargesResponse & PreviewSubscriptionChargesResponseNonNullableFields>;
+export interface PreviewSubscriptionChargesOptions extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
+    /** Information about a non-existing subscription. */
+    subscriptionInfo?: SubscriptionInfo;
+}
+/**
+ * Retrieves the preview of subscription charges for a bulk of subscriptions.
+ * Returns all the charges applicable to all subscriptions, based on the provided subscriptions information.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.subscriptionsBillingDetails.billingSettings
+ * @requiredField options.subscriptionsBillingDetails.billingSettings.shippingCharges.tax
+ * @requiredField options.subscriptionsBillingDetails.externalId
+ * @requiredField options.subscriptionsBillingDetails.items
+ * @requiredField options.subscriptionsBillingDetails.items.pricingModel
+ * @requiredField options.subscriptionsBillingDetails.items.tax
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.PreviewSubscriptionsCharges
+ */
+export declare function previewSubscriptionsCharges(options?: PreviewSubscriptionsChargesOptions): Promise<PreviewSubscriptionsChargesResponse & PreviewSubscriptionsChargesResponseNonNullableFields>;
+export interface PreviewSubscriptionsChargesOptions {
+    /** Information required to calculate the preview charges for the subscriptions, including an identifier. */
+    subscriptionsBillingDetails?: SubscriptionBillingDetails[];
+    /**
+     * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
+     * For instance, if a subscription costs $10 for the first 3 cycles, $12 for cycles 4 through 7,
+     * $15 for cycles 8 through 10, and $20 for cycle 11 onwards:
+     * - Sending "1" will calculate and return charges for cycles 4 through 7 since it's the first charge in the future.
+     * - Sending "2" will provide a response with charges for cycles 4 through 7 and cycles 8 through 10.
+     * - Sending "3" or more will include totals for cycles 4 through 7, cycles 8 through 10, and from cycle 11 onwards.
+     * If no value is provided, the response will include charges for all upcoming cycles, including the existing one,
+     * 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.
+     */
+    numberOfNextRecurringCharges?: number | null;
+}
+/**
+ * Creates authorization invoice with Moto settings in order to create
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId subscriptions.manage
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.InitiatePaymentMethodSetup
+ */
+export declare function initiatePaymentMethodSetup(_id: string, options?: InitiatePaymentMethodSetupOptions): Promise<InitiatePaymentMethodSetupResponse & InitiatePaymentMethodSetupResponseNonNullableFields>;
+export interface InitiatePaymentMethodSetupOptions {
+    paymentMode?: PaymentMode;
+    paymentSettings?: PaymentSettings;
+}
+/**
+ * This used only for automation and permitted tenants (QA & testing)
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.tenantId
+ * @requiredField subscriptionId
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsBackOfficeService.PayCycle
+ */
+export declare function payCycle(subscriptionId: string, options?: PayCycleOptions): Promise<PayCycleResponse & PayCycleResponseNonNullableFields>;
+export interface PayCycleOptions {
+    paymentTestMode?: PaymentTestMode;
+    tenantId: string;
+}
+export {};