@wix/auto_sdk_subscription_subscriptions 1.0.7 → 1.0.9

package/build/internal/cjs/index.typings.d.ts

@@ -1 +1,4708 @@
-export * from './src/billing-v1-subscription-subscriptions.universal.js';
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface Subscription {
+    /**
+     * Subscription's unique id. Automatically generated and read-only.
+     * @format GUID
+     * @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
+     * @maxLength 150
+     */
+    name?: string;
+    /**
+     * Subscription description. Optional.
+     * @maxLength 500
+     */
+    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?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
+    /** 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.
+     * @maxSize 10
+     */
+    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.
+     * @format GUID
+     */
+    orderId?: string | null;
+    /** Platform origin subscription is coming from. */
+    platformOrigin?: PlatformOrigin;
+    /**
+     * The Business Location ID represents a business location in an external service, which includes the business address.
+     * @format GUID
+     */
+    businessLocationId?: string | null;
+    /**
+     * items, minSize is 1, maxSize is 100
+     * @maxSize 100
+     */
+    items?: Item[];
+}
+interface BusinessOrigin {
+    /** @format GUID */
+    appId?: string | null;
+    /** @format GUID */
+    entityId?: string | null;
+}
+interface Customer extends CustomerIdOneOf {
+    /**
+     * Visitor ID of the customer. Available when the customer is an anonymous
+     * site visitor.
+     * @format GUID
+     */
+    visitorId?: string;
+    /**
+     * Contact ID of the customer. Available when the customer is a
+     * [contact](https://dev.wix.com/docs/rest/api-reference/people-communications/contacts/contacts/contact-v-4#contact-object).
+     * @format GUID
+     */
+    contactId?: string;
+    /**
+     * Member ID of the customer. Available when the customer is a
+     * [member](https://dev.wix.com/docs/rest/api-reference/people-communications/members/members#member-object).
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * Wix account ID
+     * @format GUID
+     */
+    accountId?: string;
+}
+/** @oneof */
+interface CustomerIdOneOf {
+    /**
+     * Visitor ID of the customer. Available when the customer is an anonymous
+     * site visitor.
+     * @format GUID
+     */
+    visitorId?: string;
+    /**
+     * Contact ID of the customer. Available when the customer is a
+     * [contact](https://dev.wix.com/docs/rest/api-reference/people-communications/contacts/contacts/contact-v-4#contact-object).
+     * @format GUID
+     */
+    contactId?: string;
+    /**
+     * Member ID of the customer. Available when the customer is a
+     * [member](https://dev.wix.com/docs/rest/api-reference/people-communications/members/members#member-object).
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * Wix account ID
+     * @format GUID
+     */
+    accountId?: string;
+}
+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"
+}
+/** @enumType */
+type SubscriptionStatusEnumSubscriptionStatusWithLiterals = SubscriptionStatusEnumSubscriptionStatus | 'UNKNOWN' | 'DRAFT' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'CANCELED';
+interface BillingSettings {
+    /**
+     * Currency of all subscription items prices. Three letter ISO currency code. https://en.wikipedia.org/wiki/ISO_4217
+     * @format CURRENCY
+     */
+    currency?: string;
+    /** customer payment source to make recurring payments with */
+    paymentMethod?: PaymentMethod;
+    /** Instructs how payments will be collected. */
+    collectionMethod?: CollectionMethodEnumCollectionMethodWithLiterals;
+    /**
+     * 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.
+     * @min 1
+     */
+    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
+     * @format DECIMAL_VALUE
+     * @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
+     * @maxSize 5
+     */
+    additionalFees?: AdditionalFee[];
+    /** Shipping fee charges */
+    shippingCharges?: ShippingCharges;
+    /**
+     * General discount that applied to all items in the subscription
+     * @maxSize 5
+     */
+    discounts?: Discount[];
+    /**
+     * Details about the external collection service.
+     * Only set when the collection_method is EXTERNAL.
+     */
+    externalCollectionDetails?: ExternalCollectionDetails;
+}
+interface PaymentMethod {
+    /**
+     * reference to payment source id stored in payments system
+     * @format GUID
+     */
+    _id?: string;
+}
+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"
+}
+/** @enumType */
+type CollectionMethodEnumCollectionMethodWithLiterals = CollectionMethodEnumCollectionMethod | 'UNKNOWN' | 'AUTO_CHARGE' | 'OFFLINE' | 'SEND_INVOICE' | 'EXTERNAL' | 'FREE';
+interface Duration {
+    /** Duration unit: DAY, WEEK, MONTH, YEAR */
+    unit?: DurationUnitWithLiterals;
+    /**
+     * Amount of units. For example,  1 MONTH, 1 YEAR, 2 WEEKS, etc. Optional. Default is 1.
+     * @min 1
+     */
+    count?: number | null;
+}
+declare enum DurationUnit {
+    UNKNOWN = "UNKNOWN",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+/** @enumType */
+type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
+interface CustomBillingSchedule {
+    /**
+     * Amount of cycles to be paid on Subscription creation, currently only cycles_to_pay_on_creation equals to 1 is supported
+     * When used with Subscription.start_date, Subscription cycles will be paid on creation but Subscription will be activated in the future
+     * @min 1
+     * @max 1
+     */
+    cyclesToPayOnCreation?: number | null;
+}
+interface FullAddressDetails {
+    /** Details about the person associated with the address. */
+    contactDetails?: FullAddressContactDetails;
+    /** Information about the address. */
+    address?: Address;
+}
+interface FullAddressContactDetails {
+    /** First name of the contact. */
+    firstName?: string | null;
+    /** Last name of the contact. */
+    lastName?: string | null;
+    /**
+     * Phone number of the contact.
+     * @format PHONE
+     */
+    phone?: string | null;
+    /** Company associated with the contact. */
+    company?: string | null;
+    /**
+     * Email address of the contact.
+     * @format EMAIL
+     */
+    email?: string | null;
+}
+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.
+     * @format COUNTRY
+     */
+    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 */
+interface AddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+interface StreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+}
+interface TaxSettings {
+    /** If true then taxes are included in given prices */
+    inclusive?: boolean;
+}
+interface AdditionalFee {
+    /**
+     * Name of the conditional fee.
+     *
+     * Max: 500 characters
+     * @maxLength 500
+     */
+    name?: string;
+    /**
+     * Amount of the conditional fee.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
+     */
+    amount?: string;
+    /**
+     * 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?: AdditionalFeeTriggerWithLiterals;
+    /** 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;
+}
+declare enum AdditionalFeeTrigger {
+    UNKNOWN = "UNKNOWN",
+    /** Charge upon subscription first payment */
+    FIRST_PAYMENT = "FIRST_PAYMENT"
+}
+/** @enumType */
+type AdditionalFeeTriggerWithLiterals = AdditionalFeeTrigger | 'UNKNOWN' | 'FIRST_PAYMENT';
+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`
+     * @decimalValue options { gt:0.00 }
+     */
+    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`
+     * @decimalValue options { gt:0.00, lte:100 }
+     */
+    percentage?: string;
+    /** Dynamic tax calculation */
+    dynamic?: DynamicTax;
+}
+/** @oneof */
+interface TaxValueOneOf {
+    /**
+     * Tax amount for the invoice's line item. Available when the tax is an
+     * amount and not a precentage.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
+     */
+    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`
+     * @decimalValue options { gt:0.00, lte:100 }
+     */
+    percentage?: string;
+    /** Dynamic tax calculation */
+    dynamic?: DynamicTax;
+}
+interface DynamicTax {
+    /**
+     * Tax group ID used to calculate tax, default will be used if not available
+     * @format GUID
+     */
+    taxGroupId?: string | null;
+    /** Taxable address used to calculate tax */
+    taxableAddressType?: TaxableAddressTypeWithLiterals;
+}
+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"
+}
+/** @enumType */
+type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
+interface Cycles {
+    /**
+     * The cycle will start. Minimum cycle number is 1
+     * @min 1
+     */
+    cycleFrom?: number;
+    /**
+     * Number of cycles to be applied on. In order to apply a on all cycles until the end of the subscription, this field should be empty.
+     * @min 1
+     */
+    numberOfCycles?: number | null;
+}
+interface Origin {
+    /** @format GUID */
+    appId?: string;
+    /** @format GUID */
+    entityId?: string;
+}
+interface ShippingCharges {
+    /**
+     * Amount of the shipping fee in `0.00` format.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     */
+    amount?: string;
+    /** Tax of the shipping fee */
+    tax?: Tax;
+    /** @maxSize 5 */
+    discounts?: Discount[];
+}
+interface Discount extends DiscountValueOneOf {
+    /**
+     * Discount amount.
+     * Available when the discount is an amount.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
+     */
+    amount?: string;
+    /**
+     * Discount percentage.
+     * Available when the discount is a parcentage value.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
+     */
+    percentage?: string;
+    cycles?: DiscountCycles;
+    /** Discount origin is coming from. Contains app_id and entity_id */
+    origin?: DiscountOrigin;
+}
+/** @oneof */
+interface DiscountValueOneOf {
+    /**
+     * Discount amount.
+     * Available when the discount is an amount.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
+     */
+    amount?: string;
+    /**
+     * Discount percentage.
+     * Available when the discount is a parcentage value.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
+     */
+    percentage?: string;
+}
+interface DiscountCycles {
+    /**
+     * The cycle from which the discount will start. Minimum cycle number is 1
+     * @min 1
+     */
+    cycleFrom?: number;
+    /**
+     * Number of cycles to be applied on them discount. In order to apply a discount on all cycles until the end of the subscription, this field should be empty.
+     * @min 1
+     */
+    numberOfCycles?: number | null;
+}
+interface DiscountOrigin {
+    /** @format GUID */
+    appId?: string;
+    /** @format GUID */
+    entityId?: string;
+}
+interface ExternalCollectionDetails {
+    /** The name of the external collector. */
+    collectorName?: string;
+}
+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 */
+interface PaymentData {
+    /** @format GUID */
+    invoiceId?: string;
+    paymentStatus?: PaymentStatusWithLiterals;
+    totals?: Totals;
+    initialFailedPaymentDate?: Date | null;
+}
+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"
+}
+/** @enumType */
+type PaymentStatusWithLiterals = PaymentStatus | 'UNKNOWN' | 'UNPAID' | 'PAID' | 'FAILED';
+interface Totals {
+    /**
+     * Total price of the subscription that the customer must pay per billing
+     * cycle. Calculated as: `subtotal + tax + shippingFee + applicationFee + extraCharge - discount - credit`
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    totalPrice?: string;
+    /**
+     * Subtotal of all line items that belong to the subscription.
+     * Calculated as: `sum_{i=1}^{n} (itemPrice[i] * quantity[i])`
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    subtotal?: string;
+    /**
+     * Total tax.
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    tax?: string | null;
+    /**
+     * Total discount.
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    discount?: string | null;
+    /**
+     * Total application fee.
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    applicationFee?: string | null;
+    /**
+     * Total shipping fee.
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    shippingFee?: string | null;
+    /**
+     * Total extra charges without tax.
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    extraCharge?: string | null;
+    /**
+     * Total credits without tax.
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    credit?: string | null;
+    /**
+     * The tax amount for the proration, which is also included in the total tax.
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    prorationTax?: string | null;
+}
+interface FreeTrialData {
+    /**
+     * Date when free trial starts
+     * @readonly
+     */
+    startDate?: Date | null;
+    /**
+     * Date when free trial ends
+     * @readonly
+     */
+    endDate?: Date | null;
+}
+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;
+}
+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 */
+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;
+}
+interface TimeBasedProration {
+}
+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`
+     * @decimalValue options { gt:0.00 }
+     */
+    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`
+     * @decimalValue options { gt:0.00 }
+     */
+    credit?: string;
+}
+/** @oneof */
+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`
+     * @decimalValue options { gt:0.00 }
+     */
+    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`
+     * @decimalValue options { gt:0.00 }
+     */
+    credit?: string;
+}
+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;
+}
+interface AutomaticRetryData {
+    enabled?: boolean;
+}
+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;
+}
+interface PauseInfo {
+    pausePolicy?: PausePolicyWithLiterals;
+    pauseAt?: PauseAtWithLiterals;
+    startDate?: Date | null;
+    startCycle?: number | null;
+    resumeAt?: ResumeAtWithLiterals;
+    resumeDate?: Date | null;
+    resumeCycle?: number | null;
+}
+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"
+}
+/** @enumType */
+type PausePolicyWithLiterals = PausePolicy | 'NONE' | 'SERVICE_AND_PAYMENTS' | 'SERVICE_ONLY';
+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"
+}
+/** @enumType */
+type PauseAtWithLiterals = PauseAt | 'NONE' | 'IMMEDIATELY' | 'NEXT_BILLING_DATE' | 'SPECIFIC_DATE' | 'NUMBER_OF_CYCLES_FROM_TODAY';
+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"
+}
+/** @enumType */
+type ResumeAtWithLiterals = ResumeAt | 'NONE' | 'IMMEDIATELY' | 'NEXT_BILLING_DATE' | 'SPECIFIC_DATE';
+interface CancellationInfo {
+    /** Subscription cancel date. Can contain a future or past date */
+    cancellationDate?: Date | null;
+    /** Initiator for cancellation */
+    initiator?: HistoryActionInitiatorWithLiterals;
+    /** Reason for cancellation. Optional. */
+    reason?: string | null;
+}
+declare enum HistoryActionInitiator {
+    UNDEFINED = "UNDEFINED",
+    BUSINESS = "BUSINESS",
+    CUSTOMER = "CUSTOMER",
+    SYSTEM = "SYSTEM",
+    PAYMENT_FAILURE = "PAYMENT_FAILURE"
+}
+/** @enumType */
+type HistoryActionInitiatorWithLiterals = HistoryActionInitiator | 'UNDEFINED' | 'BUSINESS' | 'CUSTOMER' | 'SYSTEM' | 'PAYMENT_FAILURE';
+interface SubscriptionUpdateData {
+    /** @maxSize 100 */
+    itemsToUpdate?: ItemChange[];
+    /** @maxSize 99 */
+    itemsToAdd?: Item[];
+    /**
+     * @format GUID
+     * @maxSize 99
+     */
+    itemsToDelete?: string[] | null;
+    /** @readonly */
+    numberOfRequests?: number;
+}
+interface ItemChange {
+    /**
+     * Item ID
+     * @format GUID
+     */
+    _id?: string;
+    pricingModel?: PricingModel;
+    /** @min 1 */
+    quantity?: number | null;
+    tax?: Tax;
+}
+interface PricingModel extends PricingModelModelOneOf {
+    /** Details about the fixed item price. */
+    fixedPrice?: FixedPrice;
+}
+/** @oneof */
+interface PricingModelModelOneOf {
+    /** Details about the fixed item price. */
+    fixedPrice?: FixedPrice;
+}
+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`
+     * @decimalValue options { gte:0.00 }
+     */
+    itemPrice?: string;
+}
+interface Item {
+    /**
+     * Unique identifier of subscription item. Automatically generated and read-only.
+     * @readonly
+     * @format GUID
+     */
+    _id?: string | null;
+    /**
+     * Name of the item. Typically product name.
+     * @minLength 1
+     * @maxLength 200
+     */
+    name?: string;
+    /**
+     * Description of the item.
+     * @maxLength 500
+     */
+    description?: string | null;
+    /** References to external product catalog data known to client. */
+    catalogReference?: CatalogReference;
+    /** Category of item. Whether it is digital or physical one. */
+    category?: ItemCategoryWithLiterals;
+    /**
+     * Amount of products
+     * @min 1
+     */
+    quantity?: number;
+    /** Pricing model of the item. Whether fixed price or dynamic price models. */
+    pricingModel?: PricingModel;
+    /** Tax, positive value, optional */
+    tax?: Tax;
+    /**
+     * Discounts applied on item price
+     * @maxSize 5
+     */
+    discounts?: Discount[];
+    /** Application specific fee, positive value, optional (if application_fee == 0, don't include it to request). Only positive values. */
+    applicationFee?: ApplicationFee;
+    /**
+     * External reference identifier for mapping item in consumer's system.
+     * This allows the consumer to correlate the item in their system with the item in this API.
+     * @format GUID
+     */
+    externalId?: string | null;
+    /**
+     * Key / Value store to keep up to 10 additional values related to the subscription item.
+     * Key max length = 50, Value max length = 200. Value can not be empty.
+     * Should not include any sensitive or PII information.
+     * @maxSize 10
+     */
+    metadata?: Record<string, string>;
+}
+interface CatalogReference {
+    /**
+     * Product ID from the external catalog.
+     * @minLength 1
+     * @maxLength 50
+     */
+    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
+     * @minLength 1
+     * @maxLength 50
+     */
+    appId?: string | null;
+}
+declare enum ItemCategory {
+    UNKNOWN = "UNKNOWN",
+    PHYSICAL = "PHYSICAL",
+    DIGITAL = "DIGITAL"
+}
+/** @enumType */
+type ItemCategoryWithLiterals = ItemCategory | 'UNKNOWN' | 'PHYSICAL' | 'DIGITAL';
+interface ApplicationFee extends ApplicationFeeValueOneOf {
+    /**
+     * Amount of the application fee in `0.00` format.
+     * @format DECIMAL_VALUE
+     */
+    amount?: string;
+    /**
+     * Discounts for the application fee.
+     *
+     * Max: 5 discounts
+     * @maxSize 5
+     */
+    discounts?: Discount[];
+}
+/** @oneof */
+interface ApplicationFeeValueOneOf {
+    /**
+     * Amount of the application fee in `0.00` format.
+     * @format DECIMAL_VALUE
+     */
+    amount?: string;
+}
+interface SpecificDateSubscriptionUpdateData {
+    updateData?: SubscriptionUpdateData;
+    executionDate?: Date | null;
+}
+interface PlatformOrigin {
+    /** @format GUID */
+    appId?: string | null;
+    /** @format GUID */
+    entityId?: string | null;
+}
+interface SubscriptionBillingCyclePaid {
+    /** The subscription for which one of the invoices has been marked as paid */
+    subscription?: Subscription;
+    /** The cycle that has been marked as paid */
+    paidCycle?: number;
+    /**
+     * The invoice ID that has been marked as paid
+     * @format GUID
+     */
+    invoiceId?: string;
+    /**
+     * The transaction ID of the payment order that has been marked as paid
+     * @format GUID
+     */
+    paymentTransactionId?: string | null;
+}
+interface GetSubscriptionRequest {
+    /** @format GUID */
+    _id: string;
+}
+interface GetSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface CustomerCancelSubscriptionRequest {
+    /** @format GUID */
+    _id: string;
+    /** Optional action reason message */
+    reason?: string | null;
+}
+interface CustomerCancelSubscriptionResponse {
+    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
+ */
+interface SubscriptionCanceled {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+interface ActionDetails {
+    initiator?: HistoryActionInitiatorWithLiterals;
+    reason?: string | null;
+}
+interface CustomerTurnOnAutoRenewalRequest {
+    /** @format GUID */
+    _id: string;
+    /** Optional action reason message */
+    reason?: string | null;
+}
+interface CustomerTurnOnAutoRenewalResponse {
+    subscription?: Subscription;
+}
+interface CustomerTurnOffAutoRenewalRequest {
+    /** @format GUID */
+    _id: string;
+    /** Optional action reason message */
+    reason?: string | null;
+}
+interface CustomerTurnOffAutoRenewalResponse {
+    subscription?: Subscription;
+}
+interface CustomerExtendSubscriptionRequest {
+    /**
+     * The ID of the subscription to be extended
+     * @format GUID
+     */
+    _id: string;
+    /** Optional action reason message */
+    reason?: string | null;
+    /**
+     * For termed - Subscription end date will be updated with the extension period and number of cycles will be added
+     * @min 1
+     */
+    billingCyclesToAdd: number | null;
+}
+interface CustomerExtendSubscriptionResponse {
+    /** The now extended subscription */
+    subscription?: Subscription;
+}
+interface SubscriptionExtended extends SubscriptionExtendedExtendPolicyOneOf {
+    extensionPeriod?: Duration;
+    extensionBillingCycles?: number;
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+/** @oneof */
+interface SubscriptionExtendedExtendPolicyOneOf {
+    extensionPeriod?: Duration;
+    extensionBillingCycles?: number;
+}
+interface QuerySubscriptionsRequest {
+    query?: QueryV2;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset 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 [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     */
+    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 */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset 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;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QuerySubscriptionsResponse {
+    subscriptions?: Subscription[];
+    metadata?: PagingMetadataV2;
+}
+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;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface CountSubscriptionsRequest {
+    /** Filters to specify which subscriptions are counted. */
+    filter?: CountSubscriptionFilter;
+}
+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?: SubscriptionStatusGroupWithLiterals;
+    /**
+     * Customer ID to filter the counted subscriptions by. You can pass a
+     * [member ID](https://bo.wix.com/wix-docs/rest/members/members/member-object),
+     * [contact ID](https://bo.wix.com/wix-docs/rest/crm/contacts/contacts-v4/contact-object),
+     * or the ID of an anonymous site visitor as `customerId`. When providing a
+     * `customerId` you must also specify a `paymentMethodId`.
+     * @format GUID
+     */
+    customerId?: string | null;
+    /**
+     * ID of the payment method to filter the counted subscriptions by.
+     * You must provide a `paymentMethodId` when passing a `customerId`.
+     * @format GUID
+     */
+    paymentMethodId?: string | null;
+}
+/** @oneof */
+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?: SubscriptionStatusGroupWithLiterals;
+}
+interface SubscriptionStatus {
+    /**
+     * Statuses to filter the counted subscriptions by.
+     *
+     * Max: 6 statuses
+     * @maxSize 6
+     */
+    statuses?: SubscriptionStatusEnumSubscriptionStatusWithLiterals[];
+}
+declare enum SubscriptionStatusGroup {
+    ALL = "ALL",
+    /** Union of ACTIVE, PAUSED and PENDING */
+    LIVE = "LIVE"
+}
+/** @enumType */
+type SubscriptionStatusGroupWithLiterals = SubscriptionStatusGroup | 'ALL' | 'LIVE';
+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;
+}
+interface CountByStatus {
+    /** Subscription status. */
+    status?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
+    /** Number of subscriptions with the status that match the filters. */
+    count?: number;
+}
+interface UpdateSubscriptionPaymentMethodRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    _id: string;
+    /** @format GUID */
+    paymentMethodId: string;
+}
+interface UpdateSubscriptionPaymentMethodResponse {
+    subscription?: Subscription;
+}
+interface CustomerAllowedActionsRequest {
+    /** @format GUID */
+    _id: string;
+}
+interface CustomerAllowedActionsResponse {
+    actions?: Action[];
+}
+interface Action {
+    actionType?: ActionTypeWithLiterals;
+    pausePolicies?: PausePolicyWithLiterals[];
+    pauseAt?: PauseAtWithLiterals[];
+    resumeAt?: ResumeAtWithLiterals[];
+    extendPolicies?: ExtendPolicyTypeWithLiterals[];
+}
+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"
+}
+/** @enumType */
+type ActionTypeWithLiterals = ActionType | 'NONE' | 'CREATION' | 'CANCEL' | 'CYCLE_AUTO_RENEW_ON' | 'CYCLE_AUTO_RENEW_OFF' | 'PAUSE' | 'RESUME' | 'MARK_AS_PAID' | 'EXTEND' | 'UPDATE' | 'UPDATE_START_DATE' | 'UPM' | 'UPDATE_BILLING_DATE' | 'UPDATE_COLLECTION_METHOD';
+declare enum ExtendPolicyType {
+    PERIOD = "PERIOD",
+    BILLING_CYCLE = "BILLING_CYCLE"
+}
+/** @enumType */
+type ExtendPolicyTypeWithLiterals = ExtendPolicyType | 'PERIOD' | 'BILLING_CYCLE';
+interface CustomerListUpcomingChargesRequest {
+    /**
+     * Subscription id upcoming charge to be previewed for
+     * @format GUID
+     */
+    _id: string;
+}
+interface CustomerListUpcomingChargesResponse {
+    /** Subscription upcoming charge. Will be empty if no more billing scheduled. */
+    upcomingCharge?: SubscriptionCharge;
+}
+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;
+}
+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.
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
+     * that belongs to the invoice line item.
+     * @format GUID
+     */
+    subscriptionId?: string | null;
+    /**
+     * Name of the invoice line item.
+     * Typically the product name.
+     *
+     * Max: 200 characters
+     * @minLength 1
+     * @maxLength 200
+     */
+    name?: string;
+    /**
+     * Description of the invoice line item.
+     *
+     * Max: 500 characters
+     * @maxLength 500
+     */
+    description?: string | null;
+    /** Information about the product from the external product catalog. */
+    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?: ItemCategoryWithLiterals;
+    /** 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;
+    /**
+     * ID of the [one time] that belongs to the invoice line item.
+     * @format GUID
+     */
+    oneTimeItemId?: string | null;
+    /**
+     * Key / Value store to keep up to 10 additional values related to the invoice item.
+     * Key max length = 50, Value max length = 200. Value can not be empty.
+     * Should not include any sensitive or PII information.
+     * @maxSize 10
+     */
+    metadata?: Record<string, string>;
+}
+/** @oneof */
+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;
+}
+interface Recurring {
+    /**
+     * Number of cycles. Describes how many times a customer purchases the line item
+     * on a recurring basis.
+     */
+    cycleNumber?: number;
+}
+interface OneTime {
+}
+interface PriceDetails {
+    /**
+     * Price of the invoice line item in `0.00` format.
+     * A minus sign (-) indicates that the amount is negative.
+     * @format DECIMAL_VALUE
+     */
+    price?: string;
+    /** Information about the invoice line item's tax. */
+    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;
+}
+interface InvoiceDiscount extends InvoiceDiscountValueOneOf {
+    /**
+     * Discount amount.
+     * Available when the discount is an amount.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
+     */
+    amount?: string;
+    /**
+     * Discount percentage.
+     * Available when the discount is a percentage value.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
+     */
+    percentage?: string;
+    /** Indicates the source of the discount. . Contains app_id and entity_id */
+    origin?: DiscountOrigin;
+}
+/** @oneof */
+interface InvoiceDiscountValueOneOf {
+    /**
+     * Discount amount.
+     * Available when the discount is an amount.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
+     */
+    amount?: string;
+    /**
+     * Discount percentage.
+     * Available when the discount is a percentage value.
+     *
+     * Min: `0.01`
+     * Max: `100`
+     * @decimalValue options { gt:0.00, lte:100 }
+     */
+    percentage?: string;
+}
+interface InvoiceApplicationFee extends InvoiceApplicationFeeValueOneOf {
+    /**
+     * Application fee amount. Set by the origin app, and not by BASS. Wix
+     * receives the full `applicationFee`, while the merchant doesn't receive
+     * any portion of it.
+     * @format DECIMAL_VALUE
+     */
+    amount?: string;
+    /** Information about the discount for the invoice line item's application fee. */
+    discount?: InvoiceDiscount;
+}
+/** @oneof */
+interface InvoiceApplicationFeeValueOneOf {
+    /**
+     * Application fee amount. Set by the origin app, and not by BASS. Wix
+     * receives the full `applicationFee`, while the merchant doesn't receive
+     * any portion of it.
+     * @format DECIMAL_VALUE
+     */
+    amount?: string;
+}
+interface ItemTaxData {
+    /** Aggregated tax from tax_breakdowns */
+    lineItemTaxSummary?: LineItemTaxSummary;
+    /**
+     * A detailed description of all the tax authorities applied on this item.
+     * @minSize 1
+     * @maxSize 100
+     */
+    taxBreakdowns?: TaxBreakdown[];
+}
+interface LineItemTaxSummary {
+    /**
+     * Calculated from external tax summary
+     * @format DECIMAL_VALUE
+     */
+    aggregatedTaxAmount?: string;
+    /**
+     * Aggregated from tax_breakdowns
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
+    aggregatedTaxRate?: string;
+    /**
+     * Total taxable amount for this line item.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
+    taxableAmount?: string;
+    /**
+     * Aggregated from tax_breakdowns after applying exemptions
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
+    finalTaxAmount?: string | null;
+}
+interface TaxBreakdown {
+    taxType?: string;
+    /** @decimalValue options { maxScale:4 } */
+    taxRate?: string;
+    /** @format DECIMAL_VALUE */
+    taxAmount?: string | null;
+    /** @format DECIMAL_VALUE */
+    taxableAmount?: string | null;
+    /** @format DECIMAL_VALUE */
+    nonTaxableAmount?: string | null;
+    /**
+     * Name of the tax that was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
+     * @maxLength 200
+     */
+    taxName?: string | null;
+    /**
+     * Jurisdiction that taxes were calculated for.
+     * @maxLength 200
+     */
+    jurisdiction?: string | null;
+    /** Type of jurisdiction that taxes were calculated for. */
+    jurisdictionType?: string;
+}
+interface InitiatePaymentMethodSetupRequest {
+    _id: string;
+    paymentMode?: PaymentModeWithLiterals;
+    paymentSettings?: PaymentSettings;
+}
+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"
+}
+/** @enumType */
+type PaymentModeWithLiterals = PaymentMode | 'NONE' | 'CHARGE' | 'AUTHORIZATION';
+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?: OrderMethodWithLiterals;
+    /** Wix Pay callback url(s) to return buyer to a third party system */
+    redirectUrls?: RedirectUrls;
+    /** @format GUID */
+    paymentMethodId?: string | null;
+    /**
+     * Specifies an alternative origin for processing the payment.
+     * When set, the payment order will be created with the specified origin
+     * instead of the default origin.
+     */
+    paymentOrigin?: PaymentOrigin;
+}
+declare enum OrderMethod {
+    UNKNOWN = "UNKNOWN",
+    MOTO = "MOTO",
+    NOT_MOTO = "NOT_MOTO"
+}
+/** @enumType */
+type OrderMethodWithLiterals = OrderMethod | 'UNKNOWN' | 'MOTO' | 'NOT_MOTO';
+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;
+}
+interface PaymentOrigin {
+    /**
+     * ID of the app for which the Payment will create the order on. For example, Paypal.
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Id of the entity that order will be created on
+     * @format GUID
+     */
+    instanceId?: string;
+}
+interface InitiatePaymentMethodSetupResponse {
+    /** @format GUID */
+    paymentOrderId?: string;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface CreateSubscriptionInStateRequest extends CreateSubscriptionInStateRequestModeOneOf {
+    activeSubscription?: CreateSubscriptionRequest;
+}
+/** @oneof */
+interface CreateSubscriptionInStateRequestModeOneOf {
+    activeSubscription?: CreateSubscriptionRequest;
+}
+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
+     * @format GUID
+     */
+    idempotencyKey?: string | null;
+    /** Optional origin override for setting identity of subscription creator instead of extracting from context */
+    originOverride?: OriginOverride;
+}
+interface OriginOverride {
+    /** @format GUID */
+    appId?: string;
+    /** @format GUID */
+    instanceId?: string;
+}
+interface CreateSubscriptionInStateResponse {
+    /** @format GUID */
+    subscriptionId?: string;
+}
+interface PayCycleRequest {
+    /** @format GUID */
+    subscriptionId: string;
+    paymentTestMode?: PaymentTestModeWithLiterals;
+    /** @format GUID */
+    tenantId: string;
+}
+declare enum PaymentTestMode {
+    REGULAR = "REGULAR",
+    FAIL_TECHNICAL = "FAIL_TECHNICAL",
+    FAIL_DECLINE = "FAIL_DECLINE",
+    FAIL_RETRYABLE_DECLINE = "FAIL_RETRYABLE_DECLINE"
+}
+/** @enumType */
+type PaymentTestModeWithLiterals = PaymentTestMode | 'REGULAR' | 'FAIL_TECHNICAL' | 'FAIL_DECLINE' | 'FAIL_RETRYABLE_DECLINE';
+interface PayCycleResponse {
+    /** @format GUID */
+    invoiceId?: string;
+    /** @format GUID */
+    paymentOrderId?: string | null;
+    subscription?: Subscription;
+}
+interface GetFullSubscriptionDataRequest {
+    /** @format GUID */
+    _id?: string;
+}
+interface GetFullSubscriptionDataResponse {
+    subscription?: Subscription;
+    internalSubscriptionData?: InternalSubscriptionData;
+}
+interface InternalSubscriptionData {
+    /** @format GUID */
+    originInstanceId?: string;
+    source?: string | null;
+    billingType?: string;
+    isOneTime?: boolean;
+    migrationDetails?: MigrationDetails;
+    pausePaidDuration?: string | null;
+    authorizationPaymentData?: PaymentData;
+    currentCyclePausePeriods?: PausePeriod[];
+}
+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;
+}
+interface PausePeriod {
+    startDate?: Date | null;
+    endDate?: Date | null;
+}
+interface GetSubscriptionAndInternalDataRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+}
+interface GetSubscriptionAndInternalDataResponse {
+    subscription?: Subscription;
+    internalSubscriptionData?: InternalSubscriptionData;
+}
+interface SearchSubscriptionRequest {
+    /** @format GUID */
+    _id?: string;
+    /** @format GUID */
+    tenantId?: string;
+}
+interface SearchSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface UpdatePausePaidDurationRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /**
+     * @min 1
+     * @max 10000000
+     */
+    pausePaidDurationSeconds?: string;
+    /** @format GUID */
+    tenantId?: string;
+}
+interface UpdatePausePaidDurationResponse {
+}
+interface UpdateStatusRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    status?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
+}
+interface UpdateStatusResponse {
+    subscription?: Subscription;
+}
+interface UpdatePaymentStatusRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    paymentStatus?: PaymentStatusWithLiterals;
+}
+interface UpdatePaymentStatusResponse {
+    subscription?: Subscription;
+}
+interface ReviveSubscriptionRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    revivePolicy?: RevivePolicyWithLiterals;
+    isTestRun?: boolean;
+}
+declare enum RevivePolicy {
+    SIMPLE = "SIMPLE",
+    RESUME = "RESUME"
+}
+/** @enumType */
+type RevivePolicyWithLiterals = RevivePolicy | 'SIMPLE' | 'RESUME';
+interface ReviveSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface ConvertSapiRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+}
+interface ConvertSapiResponse {
+    subscription?: Subscription;
+}
+interface GetSubscriptionInvoicesRequest {
+    /** @format GUID */
+    _id?: string;
+}
+interface GetSubscriptionInvoicesResponse {
+    invoices?: SubscriptionInvoice[];
+}
+interface SubscriptionInvoice {
+    /** @format GUID */
+    _id?: string;
+    subscriptionCycle?: number;
+    _createdDate?: Date | null;
+}
+interface FinishFreeTrialNowRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+}
+interface FinishFreeTrialNowResponse {
+    subscription?: Subscription;
+}
+interface FixSubscriptionTimeCapsuleTasksRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+}
+interface FixSubscriptionTimeCapsuleTasksResponse {
+}
+interface SendTimeCapsuleTaskCanceledBIRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @minLength 1 */
+    taskType?: string;
+}
+interface Empty {
+}
+interface ScheduleTimeCapsuleTaskRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @minLength 1 */
+    taskType?: string;
+    executionTime?: Date | null;
+    /** @format GUID */
+    tenantId?: string;
+}
+interface CancelTimeCapsuleTaskRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @minLength 1 */
+    taskType?: string;
+}
+interface UpdateFullSubscriptionRequest {
+    /** @format GUID */
+    tenantId?: string;
+    subscription?: Subscription;
+}
+interface UpdateFullSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface UpdateSubscriptionInvoiceCycleRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    invoiceId?: string;
+    subscriptionCycle?: number;
+}
+interface UpdateSubscriptionInvoiceCycleResponse {
+    subscriptionInvoice?: SubscriptionInvoice;
+}
+interface AddPausePeriodRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    pauseStartDate?: Date | null;
+    pauseEndDate?: Date | null;
+}
+interface AddPausePeriodResponse {
+    subscription?: Subscription;
+}
+interface RunTimeCapsuleTaskNowRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @minLength 1 */
+    taskType?: string;
+}
+interface CreateRecurringInvoiceBORequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    /** @min 2 */
+    cycleNumber?: number;
+}
+interface CreateRecurringInvoiceBOResponse {
+    invoiceId?: string;
+}
+interface SetShiftingDataRequest {
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    tenantId?: string;
+    isBassManaged?: boolean;
+    shiftManagementDate?: Date | null;
+}
+interface SetShiftingDataResponse {
+    subscription?: Subscription;
+}
+interface FixSubscriptionInvoicesRequest extends FixSubscriptionInvoicesRequestModeOneOf {
+    attachInvoice?: AttachInvoice;
+    detachInvoice?: DetachInvoice;
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+/** @oneof */
+interface FixSubscriptionInvoicesRequestModeOneOf {
+    attachInvoice?: AttachInvoice;
+    detachInvoice?: DetachInvoice;
+}
+interface AttachInvoice {
+    /** @format GUID */
+    invoiceId?: string;
+}
+interface DetachInvoice {
+    /** @format GUID */
+    invoiceId?: string;
+}
+interface FixSubscriptionInvoicesResponse {
+    invoices?: SubscriptionInvoice[];
+}
+interface RestoreDraftSubscriptionRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+interface RestoreDraftSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface DeleteDraftSubscriptionRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+interface DeleteDraftSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface DeleteSubscriptionBORequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+interface DeleteSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+interface CancelSubscriptionBORequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    initiator?: ActionInitiatorWithLiterals;
+    reason?: string | null;
+}
+declare enum ActionInitiator {
+    UNDEFINED = "UNDEFINED",
+    BUSINESS = "BUSINESS",
+    CUSTOMER = "CUSTOMER",
+    SYSTEM = "SYSTEM"
+}
+/** @enumType */
+type ActionInitiatorWithLiterals = ActionInitiator | 'UNDEFINED' | 'BUSINESS' | 'CUSTOMER' | 'SYSTEM';
+interface CancelSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+interface UpdatePaymentMethodBORequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    /** @format GUID */
+    paymentMethodId?: string;
+}
+interface UpdatePaymentMethodBOResponse {
+    subscription?: Subscription;
+}
+interface SendSubscriptionActionEventBORequest extends SendSubscriptionActionEventBORequestEventOneOf {
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+}
+/** @oneof */
+interface SendSubscriptionActionEventBORequestEventOneOf {
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+}
+interface SubscriptionBillingCycleStarted {
+    subscription?: Subscription;
+    /**
+     * Wix Pay transaction id, optional. Exists if event was triggered by a payment.
+     * @format GUID
+     */
+    paymentTransactionId?: string | null;
+}
+interface SendSubscriptionActionEventResponse {
+}
+interface HandleSubscriptionAfterInvoiceMarkedAsPaidRequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    transactionId?: string;
+}
+interface PauseSubscriptionBORequest {
+    /** @format GUID */
+    tenantId?: string;
+    /** @format GUID */
+    subscriptionId?: string;
+    pausePolicy?: PausePolicyWithLiterals;
+    pauseAt?: PauseAtWithLiterals;
+    initiator?: ActionInitiatorWithLiterals;
+    /** @maxLength 500 */
+    reason?: string | null;
+}
+interface PauseSubscriptionBOResponse {
+    subscription?: Subscription;
+}
+interface SetIsMigratedEvent {
+    /** @format GUID */
+    subscriptionId?: string;
+}
+interface SubscriptionDelayedSyncEvent {
+    /** @format GUID */
+    subscriptionId?: string;
+}
+interface InvoiceAction extends InvoiceActionActionTypeOneOf {
+    payRecurring?: PayRecurringInvoice;
+}
+/** @oneof */
+interface InvoiceActionActionTypeOneOf {
+    payRecurring?: PayRecurringInvoice;
+}
+interface PayRecurringInvoice {
+    /** @format GUID */
+    invoiceId?: string;
+}
+/**
+ * Sent each time a subscription status has been set to Active
+ * Active shows that a subscription is live and operational.
+ * For example:
+ * * For subscription with free trial, free trial start date is also the activation date.
+ * * For a subscription with future start date, the start date is also the activation date.
+ * * When a subscription is resumed from a pause status, the resume date is also the activation date.
+ */
+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.
+ */
+interface SubscriptionEnded {
+    subscription?: Subscription;
+}
+interface SubscriptionInitialPurchaseCompleted {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+    /** @format GUID */
+    paymentTransactionId?: string | null;
+}
+interface SubscriptionCycleReadyToPay {
+    subscription?: Subscription;
+}
+interface SubscriptionRevived {
+    subscription?: Subscription;
+}
+interface CreateSubscriptionResponse {
+    subscription?: Subscription;
+    /**
+     * Payments order that should be paid (or authorize card) in order to activate subscription. Empty for free subscriptions.
+     * @format GUID
+     */
+    paymentOrderId?: string | null;
+}
+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[];
+}
+interface UpdateSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface UpdateSubscriptionStartDateRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * Can be updated only if Subscription is in Draft state
+     * By setting start_date in the future, end_date will be recalculated for termed Subscriptions
+     * cycles_to_pay_on_creation will be set to 1 if no free trial is set
+     */
+    startDate?: Date | null;
+}
+interface UpdateSubscriptionStartDateResponse {
+    subscription?: Subscription;
+}
+interface UpdateSubscriptionPoliciesRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    _id?: string;
+    cancellableByCustomer?: boolean | null;
+}
+interface UpdateSubscriptionPoliciesResponse {
+    /** Updated policies of the subscription */
+    policies?: SubscriptionPolicies;
+}
+interface UpdateSubscriptionBillingDateRequest {
+    /**
+     * ID of the subscription to update the billing date for.
+     * @format GUID
+     */
+    _id: string;
+    /** New billing date in `YYYY-MM-DDThh:mm:ss:sssZ` format. */
+    billingDate: Date | null;
+    /**
+     * Information about how BASS adjusts the total of the next invoice. Extending
+     * the current billing cycle results in a higher payment, while shortening it
+     * leads to a lower payment. BASS offers automatic calculation of the proration
+     * amount based on the number of days added to or removed from the current billing
+     * cycle. Alternatively, you can use your own custom method to calculate the
+     * proration amount. The custom proration amount can't exceed the total of the
+     * current billing cycle.
+     */
+    proration?: Proration;
+}
+interface UpdateSubscriptionBillingDateResponse {
+    /** Updated subscription. */
+    subscription?: Subscription;
+}
+interface SubscriptionBillingDateUpdated {
+    subscription?: Subscription;
+    billingDate?: Date | null;
+    proration?: Proration;
+}
+interface UpdateSubscriptionOriginRequest {
+    /**
+     * ID of the subscription to update origin.
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * Origin entity ID of the subscription to update.
+     * @format GUID
+     */
+    entityId?: string;
+}
+interface UpdateSubscriptionOriginResponse {
+    /** Updated subscription. */
+    subscription?: Subscription;
+}
+interface ReviseSubscriptionRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    _id?: string;
+    /**
+     * 0 for no revision, maxSize is 100
+     * @maxSize 100
+     */
+    items?: Item[];
+}
+interface ReviseSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface UpdateSubscriptionItemsRequest {
+    /**
+     * Subscription ID
+     * @format GUID
+     */
+    _id?: string;
+    /** Update action. For RESET_PENDING_UPDATES, nothing but the subscription ID should be defined in the request. */
+    updateAction?: UpdateActionWithLiterals;
+    /** Updates execution date. Relevant only for UpdateAction.SPECIFIC_DATE. Only specific date is supported. */
+    scheduleAdditionalInfo?: ScheduleAdditionalInfo;
+    /**
+     * Existing items to update
+     * @maxSize 100
+     */
+    itemsToUpdate?: ItemChange[];
+    /**
+     * Items to add
+     * @maxSize 99
+     */
+    itemsToAdd?: Item[];
+    /**
+     * Existing items to delete
+     * @format GUID
+     * @maxSize 99
+     */
+    itemsToDelete?: string[] | null;
+}
+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"
+}
+/** @enumType */
+type UpdateActionWithLiterals = UpdateAction | 'NONE' | 'IMMEDIATELY' | 'NEXT_BILLING_CYCLE' | 'RESET_PENDING_UPDATES' | 'SPECIFIC_DATE';
+interface ScheduleAdditionalInfo extends ScheduleAdditionalInfoParamOneOf {
+    /**
+     * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
+     * format. The use of this field may be restricted in various BASS endpoints.
+     * For example, in _Bulk Update Subscription Items_ it's only available in
+     * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
+     * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
+     * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
+     */
+    specificDate?: Date | null;
+    /**
+     * When the update becomes effective, as number of billing cycles from now.
+     * The use of this field may be restricted in various BASS endpoints.
+     * For example, in _Pause Subscription_ it's only available in
+     * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
+     * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
+     * @min 1
+     */
+    numberOfCycles?: number;
+}
+/** @oneof */
+interface ScheduleAdditionalInfoParamOneOf {
+    /**
+     * Future date when the update becomes effective in `YYYY-MM-DDThh:mm:ss.sssZ`
+     * format. The use of this field may be restricted in various BASS endpoints.
+     * For example, in _Bulk Update Subscription Items_ it's only available in
+     * combination with `{"updateAction": "SPECIFIC_DATE"}`, in _Resume Subscription_
+     * only in combination with `{"resumeAt": "SPECIFIC_DATE"}`, and in
+     * _Pause Subscription_ only in combination with `{"pauseAt": "SPECIFIC_DATE"}`.
+     */
+    specificDate?: Date | null;
+    /**
+     * When the update becomes effective, as number of billing cycles from now.
+     * The use of this field may be restricted in various BASS endpoints.
+     * For example, in _Pause Subscription_ it's only available in
+     * combination with `{"pauseAt": "NUMBER_OF_CYCLES_FROM_TODAY"}`.
+     * __Note__: Currently not supported in _Bulk Update Subscription Items by Filter_.
+     * @min 1
+     */
+    numberOfCycles?: number;
+}
+interface UpdateSubscriptionItemsResponse {
+    subscription?: Subscription;
+}
+interface BulkUpdateSubscriptionItemsByFilterRequest {
+    /**
+     * Filter to identify the subscriptions for which items are updated. For
+     * supported fields see
+     * [Search and Query: Bulk Update Subscription Items By Filter](https://bo.wix.com/wix-docs/rest/drafts/subscriptions-by-billing-by-wix/search-and-query#drafts_subscriptions-by-billing-by-wix_search-and-query_bulk-update-subscription-items-by-filter).
+     * Sending an empty subscription filter results in a validation error.
+     * In case you pass `{"updateAction": "RESET_PENDING_UPDATES"}`, use only the
+     * `subscriptionId` field inside this filter. Passing any other filter results
+     * in a failed validation error.
+     */
+    subscriptionFilter?: Record<string, any> | null;
+    /**
+     * Filter to specify which subscription items are updated. Make sure to use
+     * the catalog item ID and not the item's unique ID. All subscription items
+     * with matching `items.catalogReference.catalogItemId` are updated.
+     *
+     * Max: `100` reference catalog item IDs
+     * @format GUID
+     * @maxSize 100
+     */
+    catalogReferenceIds?: string[] | null;
+    /**
+     * Information about the update timing and update type.
+     *
+     * + `"IMMEDIATELY"`: The updates become effective immediately.
+     * + `"NEXT_BILLING_CYCLE"`: The updates are scheduled for the beginning of the next billing cycle.
+     * + `"SPECIFIC_DATE"`: The updates are scheduled for the date specified in `scheduleAdditionalInfo.specificDate`.
+     * + `"RESET_PENDING_UPDATES"`: All currently scheduled updates for the specified supcriptions are canceled. Use only the `subscriptionId` field inside `subscriptionFilter`, all other filters result in failed validation errors.
+     */
+    updateAction?: UpdateActionWithLiterals;
+    /**
+     * Additional information for updates. Currently, only supported for
+     * `{"updateAction": "SPECIFIC_DATE"}`.
+     */
+    scheduleAdditionalInfo?: ScheduleAdditionalInfo;
+    /**
+     * Update details for the susbcription items that match the filtering.
+     * Currently, you can update only the item price, quantity, and tax. Note
+     * that all item properties are updated to the same values. In case you want set
+     * different values for individual items, you must call
+     * _Bulk Update Subscription Items By Filter_ multiple times, once per unique update.
+     */
+    bulkItemUpdateData?: BulkItemChange;
+    /**
+     * __Not implemented yet__. Items to add to the subscriptions matching the filtering.
+     * @maxSize 99
+     */
+    itemsToAdd?: Item[];
+}
+interface BulkItemChange {
+    /** Information about the new item price. */
+    pricingModel?: PricingModel;
+    /**
+     * New item quantity.
+     *
+     * Min: `1`
+     * @min 1
+     */
+    quantity?: number | null;
+    /** Information about the new item tax. */
+    tax?: Tax;
+}
+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;
+}
+interface DeleteSubscriptionRequest {
+    /** @format GUID */
+    _id?: string;
+    revision?: string;
+}
+interface DeleteSubscriptionResponse {
+}
+interface CancelSubscriptionRequest {
+    /** @format GUID */
+    _id: string;
+    actionContext: ActionContext;
+}
+interface ActionContext {
+    initiator?: ActionInitiatorWithLiterals;
+    /** Optional action reason message */
+    reason?: string | null;
+}
+interface CancelSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface PauseSubscriptionRequest {
+    /** @format GUID */
+    _id: string;
+    pausePolicy?: PausePolicyWithLiterals;
+    pauseAt?: PauseAtWithLiterals;
+    /** 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;
+}
+interface PauseSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface SubscriptionPaused {
+    subscription?: Subscription;
+    pausePolicy?: PausePolicyWithLiterals;
+    actionDetails?: ActionDetails;
+}
+interface PauseSubscriptionRequested {
+    subscription?: Subscription;
+    pauseAt?: PauseAtWithLiterals;
+    pausePolicy?: PausePolicyWithLiterals;
+    actionDetails?: ActionDetails;
+}
+interface ScheduledPauseCanceled {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+interface ResumeSubscriptionRequest {
+    /** @format GUID */
+    _id: string;
+    resumeAt?: ResumeAtWithLiterals;
+    /** contains additional scheduling information for certain resume_at options (for example: SPECIFIC_DATE) */
+    resumeAtSchedule?: ScheduleAdditionalInfo;
+    actionContext: ActionContext;
+}
+interface ResumeSubscriptionResponse {
+    subscription?: Subscription;
+}
+interface SubscriptionResumed {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+interface ResumeSubscriptionRequested {
+    subscription?: Subscription;
+    resumeAt?: ResumeAtWithLiterals;
+    actionDetails?: ActionDetails;
+}
+interface ScheduledResumeCanceled {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+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 */
+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;
+}
+interface SortingClauses {
+    sorting?: Sorting[];
+}
+interface SearchSubscriptionsResponse {
+    subscriptions?: Subscription[];
+    cursor?: CursorPaging;
+}
+interface TurnOnSubscriptionAutoRenewalRequest {
+    /** @format GUID */
+    _id: string;
+    actionContext: ActionContext;
+}
+interface TurnOnSubscriptionAutoRenewalResponse {
+    subscription?: Subscription;
+}
+interface SubscriptionAutoRenewalTurnedOn {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+interface TurnOffSubscriptionAutoRenewalRequest {
+    /** @format GUID */
+    _id: string;
+    actionContext: ActionContext;
+}
+interface TurnOffSubscriptionAutoRenewalResponse {
+    subscription?: Subscription;
+}
+interface SubscriptionAutoRenewalTurnedOff {
+    subscription?: Subscription;
+    actionDetails?: ActionDetails;
+}
+interface MarkLatestInvoiceAsPaidRequest {
+    /**
+     * The ID of the offline subscription to mark as paid its latest invoice
+     * @format GUID
+     */
+    subscriptionId: string;
+}
+interface MarkLatestInvoiceAsPaidResponse {
+    subscription?: Subscription;
+}
+interface LatestInvoiceMarkedAsPaid {
+    subscription?: Subscription;
+}
+interface MultipleSubscriptionsOnOrdersInvoice {
+    /**
+     * the invoice id of the affected subscription
+     * @format GUID
+     */
+    invoiceId?: string;
+    /**
+     * the order id of the affected subscription
+     * @format GUID
+     */
+    orderId?: string;
+}
+interface MarkBillingCycleAsPaidRequest {
+    /**
+     * The ID of the subscription to mark as paid its invoice.
+     * @format GUID
+     */
+    subscriptionId: string;
+    /**
+     * The subscription cycle for which the invoice is to be marked as paid.
+     * If left empty, the most recent cycle will be selected.
+     * @min 1
+     */
+    paidCycle?: number | null;
+}
+interface MarkBillingCycleAsPaidResponse {
+    subscription?: Subscription;
+}
+interface GetSubscriptionsStatsRequest {
+}
+interface GetSubscriptionsStatsResponse {
+    amountByStatuses?: AmountByStatus[];
+    total?: number;
+}
+interface AmountByStatus {
+    status?: SubscriptionStatusEnumSubscriptionStatusWithLiterals;
+    amount?: number;
+}
+interface ExtendSubscriptionRequest extends ExtendSubscriptionRequestExtendPolicyOneOf {
+    /** User won't be charged for additional period added on top of subscription end date. */
+    extensionPeriod?: Duration;
+    /**
+     * user will be charged for billing cycles added
+     * @min 1
+     */
+    extensionBillingCycles?: number;
+    /**
+     * The ID of the subscription to be extended
+     * @format GUID
+     */
+    _id: string;
+    actionContext: ActionContext;
+}
+/** @oneof */
+interface ExtendSubscriptionRequestExtendPolicyOneOf {
+    /** User won't be charged for additional period added on top of subscription end date. */
+    extensionPeriod?: Duration;
+    /**
+     * user will be charged for billing cycles added
+     * @min 1
+     */
+    extensionBillingCycles?: number;
+}
+interface ExtendSubscriptionResponse {
+    /** The now extended subscription */
+    subscription?: Subscription;
+}
+interface AllowedActionsRequest {
+    /** @format GUID */
+    _id: string;
+    /**
+     * List of additional fields to be included in the response.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+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"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'UNSUPPORTED_ACTION';
+interface AllowedActionsResponse {
+    /** List of actions that are allowed. */
+    actions?: Action[];
+    /**
+     * List of actions that are not supported, included only if requested. Provides reasons for each unsupported action.
+     * @maxSize 20
+     */
+    unsupportedActions?: UnsupportedAction[];
+}
+interface UnsupportedAction {
+    actionType?: ActionTypeWithLiterals;
+    /**
+     * Provides detailed reasons for the unsupported action. Each `UnsupportedReason` includes a code and a message explaining why the action is not allowed.
+     * @maxSize 20
+     */
+    reasons?: UnsupportedReason[];
+}
+interface UnsupportedReason {
+    code?: string;
+    description?: string | null;
+}
+interface ListUpcomingChargesRequest {
+    /**
+     * Subscription id charges to be previewed for
+     * @format GUID
+     */
+    subscriptionId: string;
+    /** Period of time to provide charged for. If not provided,then only next charge will be returned. */
+    customDuration?: Duration;
+    /**
+     * Date of the next billing cycle so that the upcoming charges will be calculated accordingly.
+     * If not provided, the upcoming charges will be calculated according to the existing next billing date.
+     */
+    nextBillingDate?: Date | null;
+}
+interface ListUpcomingChargesResponse {
+    upcomingCharges?: SubscriptionCharge[];
+}
+interface PreviewSubscriptionChargesRequest extends PreviewSubscriptionChargesRequestSubscriptionOneOf {
+    /** Information about a non-existing subscription. */
+    subscriptionInfo?: SubscriptionInfo;
+}
+/** @oneof */
+interface PreviewSubscriptionChargesRequestSubscriptionOneOf {
+    /** Information about a non-existing subscription. */
+    subscriptionInfo?: SubscriptionInfo;
+}
+/** Subscription information to use for calculating the preview of charges for a subscription. */
+interface SubscriptionInfo {
+    billingSettings?: BillingSettings;
+    items?: Item[];
+    startDate?: Date | null;
+}
+interface PreviewSubscriptionChargesResponse {
+    /** Charges for subscription. */
+    charges?: Charge[];
+}
+/** Represents a charge applicable to a subscription. */
+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;
+}
+interface PreviewSubscriptionsChargesRequest {
+    /**
+     * Information required to calculate the preview charges for the subscriptions, including an identifier.
+     * @minSize 1
+     * @maxSize 10
+     */
+    subscriptionsBillingDetails?: SubscriptionBillingDetails[];
+    /**
+     * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
+     * 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.
+     * @min 1
+     * @max 10
+     */
+    numberOfNextRecurringCharges?: number | null;
+}
+interface SubscriptionBillingDetails {
+    /**
+     * External identifier of the subscription
+     * @format GUID
+     */
+    externalId?: string | null;
+    /** Billing details parameters including schedule, currency, etc. */
+    billingSettings?: BillingSettings;
+    /**
+     * Items, minSize is 1, maxSize is 100
+     * @minSize 1
+     * @maxSize 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;
+}
+interface PreviewSubscriptionsChargesResponse {
+    /** Charges for the subscriptions, including an identifier. */
+    subscriptionsCharges?: SubscriptionCharges[];
+}
+interface SubscriptionCharges {
+    /**
+     * External identifier of the subscription
+     * @format GUID
+     */
+    externalId?: string | null;
+    /** Charges for subscription. */
+    charges?: Charge[];
+}
+interface CreateSubscriptionForOrderRequest {
+    /** Subscription needs to be created */
+    subscription?: Subscription;
+    /**
+     * Optional unique identifier for this request in order to prevent subscription duplications
+     * @format GUID
+     */
+    idempotencyKey?: string | null;
+}
+interface CreateSubscriptionForOrderResponse {
+    /** Created subscription */
+    subscription?: Subscription;
+    /** Non-persistent invoice */
+    invoice?: Invoice;
+}
+/** An invoice includes information about the subscription and the customer. */
+interface Invoice {
+    /**
+     * Invoice ID.
+     * @format GUID
+     * @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?: InvoiceStatusWithLiterals;
+    /**
+     * 3-letter currency code of the invoice in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
+     */
+    currency?: string;
+    /** Information about the customer. */
+    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?: CollectionMethodWithLiterals;
+    /**
+     * 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.
+     * @format GUID
+     */
+    paymentMethodId?: string | null;
+    /**
+     * Cashier [Order ID](https://dev.wix.com/docs/rest/payments/wix-cashier/pay/order#order-object)
+     * for the corresponding payment.
+     * @format GUID
+     * @readonly
+     */
+    paymentOrderId?: string | null;
+    /** 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.
+     * @format DECIMAL_VALUE
+     */
+    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.
+     * @maxLength 10
+     * @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.
+     * @format GUID
+     */
+    orderId?: string | null;
+    /**
+     * Platform origin the invoice is originated from.
+     * @format GUID
+     */
+    platformOriginAppId?: string | null;
+    /**
+     * Refund information, provided that there are refunds for this invoice.
+     * @readonly
+     */
+    refundInfo?: RefundInfo;
+}
+interface BusinessOriginData {
+    /**
+     * ID of the app for which BASS has created the invoice. For example,
+     * `"1380b703-ce81-ff05-f115-39571d94dfcd"` for the Wix eCommerce app.
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * [Instance ID](https://dev.wix.com/api/rest/app-management/apps/app-instance/get-app-instance)
+     * of the app for which BASS has created the invoice.
+     * @format GUID
+     */
+    instanceId?: string;
+    /**
+     * ID of the entity that triggered the invoice creation. For example, the ID of a
+     * [pricing plan](https://dev.wix.com/docs/rest/payments/pricing-plans/pricing-plans/plan#plan-object).
+     * @format GUID
+     */
+    entityId?: string;
+}
+declare enum InvoiceStatus {
+    UNKNOWN = "UNKNOWN",
+    OPEN = "OPEN",
+    PAID = "PAID",
+    FAILED = "FAILED",
+    ATTEMPT_FAILED = "ATTEMPT_FAILED",
+    CANCELED = "CANCELED",
+    REFUNDED = "REFUNDED"
+}
+/** @enumType */
+type InvoiceStatusWithLiterals = InvoiceStatus | 'UNKNOWN' | 'OPEN' | 'PAID' | 'FAILED' | 'ATTEMPT_FAILED' | 'CANCELED' | 'REFUNDED';
+declare enum CollectionMethod {
+    UNKNOWN = "UNKNOWN",
+    AUTO_CHARGE = "AUTO_CHARGE",
+    OFFLINE = "OFFLINE",
+    SEND_INVOICE = "SEND_INVOICE"
+}
+/** @enumType */
+type CollectionMethodWithLiterals = CollectionMethod | 'UNKNOWN' | 'AUTO_CHARGE' | 'OFFLINE' | 'SEND_INVOICE';
+declare enum CreationMode {
+    UNKNOWN = "UNKNOWN",
+    SYSTEM = "SYSTEM",
+    MANUAL = "MANUAL"
+}
+/** @enumType */
+type CreationModeWithLiterals = CreationMode | 'UNKNOWN' | 'SYSTEM' | 'MANUAL';
+interface LatestPaymentAttempt {
+    /**
+     * ID of the latest payment attempt.
+     * @format GUID
+     * @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?: PaymentAttemptStatusWithLiterals;
+    /**
+     * Whether BASS tries to collect the payment another time. Available only when
+     * `latestPaymentAttempt.status` is set to `"DECLINED"`.
+     */
+    retryable?: boolean;
+}
+declare enum PaymentAttemptStatus {
+    UNKNOWN = "UNKNOWN",
+    SCHEDULED = "SCHEDULED",
+    IN_PROGRESS = "IN_PROGRESS",
+    PAID = "PAID",
+    DECLINED = "DECLINED",
+    TECHNICAL_FAILURE = "TECHNICAL_FAILURE",
+    CANCELED = "CANCELED",
+    PENDING = "PENDING"
+}
+/** @enumType */
+type PaymentAttemptStatusWithLiterals = PaymentAttemptStatus | 'UNKNOWN' | 'SCHEDULED' | 'IN_PROGRESS' | 'PAID' | 'DECLINED' | 'TECHNICAL_FAILURE' | 'CANCELED' | 'PENDING';
+interface PriceAdjustment extends PriceAdjustmentAdjustmentTypeOneOf {
+    /** Adjustment that increases the price. */
+    charge?: PriceAdjustmentValue;
+    /** Adjustment that lowers the price. */
+    credit?: PriceAdjustmentValue;
+}
+/** @oneof */
+interface PriceAdjustmentAdjustmentTypeOneOf {
+    /** Adjustment that increases the price. */
+    charge?: PriceAdjustmentValue;
+    /** Adjustment that lowers the price. */
+    credit?: PriceAdjustmentValue;
+}
+interface PriceAdjustmentValue extends PriceAdjustmentValueAdjustmentValueTypeOneOf {
+    /**
+     * Absolute amount that adjusts the price.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
+     */
+    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`
+     * @decimalValue options { gt:0.00, lte:1 }
+     */
+    multiplier?: string;
+}
+/** @oneof */
+interface PriceAdjustmentValueAdjustmentValueTypeOneOf {
+    /**
+     * Absolute amount that adjusts the price.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gt:0.00 }
+     */
+    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`
+     * @decimalValue options { gt:0.00, lte:1 }
+     */
+    multiplier?: string;
+}
+interface InvoiceShippingCharges {
+    /**
+     * Amount of the shipping fee in `0.00` format.
+     *
+     * Min: `0.01`
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     */
+    amount?: string;
+    /** Tax of the shipping fee */
+    tax?: Tax;
+    /** Information about the shipping charges tax data */
+    taxData?: ItemTaxData;
+    discount?: Discount;
+}
+/** Tax data from all items */
+interface TaxData {
+    /** Aggregated tax data from all items */
+    taxSummary?: TaxSummary;
+}
+interface TaxSummary {
+    /**
+     * Aggregated from tax_breakdowns with exemptions excluded from amount
+     * @format DECIMAL_VALUE
+     */
+    aggregatedTaxAmount?: string;
+    /**
+     * Array of each tax applied, grouped by `"jurisdiction"`, `"jurisdiction_type"`, `"tax_type"`, `"tax_name"` and `"tax_rate"`.
+     * @maxSize 50
+     */
+    aggregatedTaxBreakdowns?: AggregatedTaxBreakdown[];
+}
+interface AggregatedTaxBreakdown {
+    /**
+     * Name of the tax that was calculated.
+     * @maxLength 200
+     */
+    taxName?: string;
+    /**
+     * Type of tax that was calculated.
+     * @maxLength 200
+     */
+    taxType?: string;
+    /**
+     * Jurisdiction that taxes were calculated for.
+     * @maxLength 200
+     */
+    jurisdiction?: string;
+    /** Type of jurisdiction that taxes were calculated for. */
+    jurisdictionType?: string;
+    /**
+     * Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is `"0.1000"` and 200% tax is `"2.0000"`.
+     * @decimalValue options { gte:0, maxScale:6 }
+     */
+    rate?: string;
+    /**
+     * Total amount of this tax for this jurisdiction.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { maxScale:4 }
+     */
+    aggregatedTaxAmount?: string;
+}
+interface RefundInfo {
+    /**
+     * If refunds are present, this will include the total amount refunded.
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gte:0.00, maxScale:2 }
+     */
+    totalRefundAmount?: string | null;
+    /**
+     * The refunds that have been applied to this invoice
+     * @maxSize 20
+     */
+    refunds?: Refund[];
+}
+interface Refund {
+    /**
+     * refund amount
+     * @format DECIMAL_VALUE
+     * @decimalValue options { gt:0.00, maxScale:2 }
+     */
+    amount?: string;
+    /** the date of the refund transaction */
+    transactionDate?: Date | null;
+    /**
+     * the transaction id associated with this refund
+     * @format GUID
+     */
+    transactionId?: string;
+    /** a reason for the refund */
+    reason?: RefundReasonWithLiterals;
+    /**
+     * a description of the refund - this is a free text field for the initiator
+     * @maxLength 255
+     */
+    description?: string | null;
+}
+declare enum RefundReason {
+    UNKNOWN_REFUND_REASON = "UNKNOWN_REFUND_REASON",
+    DUPLICATE_CHARGE = "DUPLICATE_CHARGE",
+    FRAUDULENT = "FRAUDULENT",
+    CUSTOMER_REQUEST = "CUSTOMER_REQUEST",
+    PROVISION_FAILED = "PROVISION_FAILED",
+    OTHER = "OTHER"
+}
+/** @enumType */
+type RefundReasonWithLiterals = RefundReason | 'UNKNOWN_REFUND_REASON' | 'DUPLICATE_CHARGE' | 'FRAUDULENT' | 'CUSTOMER_REQUEST' | 'PROVISION_FAILED' | 'OTHER';
+interface Task {
+    key?: TaskKey;
+    executeAt?: Date | null;
+    payload?: string | null;
+}
+interface TaskKey {
+    appId?: string;
+    instanceId?: string;
+    subjectId?: string | null;
+}
+interface TaskAction extends TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+/** @oneof */
+interface TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+interface Complete {
+}
+interface Cancel {
+}
+interface Reschedule {
+    executeAt?: Date | null;
+    payload?: string | null;
+}
+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 */
+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;
+}
+interface V1SubscriptionCreated {
+    subscription?: V1Subscription;
+}
+interface V1Subscription {
+    /**
+     * ID of the subscription
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * ID of the app which created the subscription
+     * @format GUID
+     */
+    wixAppId?: string;
+    /**
+     * Instance ID of the Subscriptions app
+     * @format GUID
+     */
+    tenantId?: string;
+    /**
+     * ID of entity in app (e.g. a cart in stores/order in paid plans)
+     * @format GUID
+     */
+    originEntityId?: string;
+    /** Site member or a contact who bought the subscription */
+    subscriber?: Subscriber;
+    /**
+     * Wix Pay order ID, is empty for free subscriptions
+     * @format GUID
+     */
+    wixPayOrderId?: string | null;
+    /**
+     * Subscription name (e.g. a product or subscription package name)
+     * @maxLength 150
+     */
+    name?: string;
+    /**
+     * Optional additional subscription description
+     * @maxLength 500
+     */
+    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?: SubscriptionTypeWithLiterals;
+    /** Active, expired, canceled, etc. */
+    subscriptionStatus?: V1SubscriptionStatusEnumSubscriptionStatusWithLiterals;
+    /** 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?: PaymentStatusEnumPaymentStatusWithLiterals;
+    /** Payment schedule in the wix pay format. Exists for recurring subscriptions only. */
+    billingProfile?: V2Subscription;
+    /** Owner, member, etc. - present if subscription is canceled */
+    cancellationInitiator?: CancellationInitiatorWithLiterals;
+    /** 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;
+    /** @format GUID */
+    originInstanceId?: string | null;
+}
+interface Subscriber {
+    /**
+     * Member or contact ID
+     * @format GUID
+     */
+    _id?: string;
+    /** Member or contact */
+    identityType?: IdentityTypeWithLiterals;
+}
+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"
+}
+/** @enumType */
+type IdentityTypeWithLiterals = IdentityType | 'UNDEFINED' | 'MEMBER' | 'CONTACT';
+/** Price of a payment. Includes amount and currency. */
+interface Money {
+    /**
+     * Monetary amount i.e. 3.99.
+     * @format DECIMAL_VALUE
+     */
+    amount?: string;
+    /**
+     * Currency in ISO 4217 format i.e. USD.
+     * @minLength 3
+     * @maxLength 3
+     */
+    currency?: string;
+}
+declare enum SubscriptionType {
+    UNDEFINED = "UNDEFINED",
+    /** Payments made by the subscriber */
+    ONLINE = "ONLINE",
+    /** Payments managed manually by the site owner */
+    OFFLINE = "OFFLINE"
+}
+/** @enumType */
+type SubscriptionTypeWithLiterals = SubscriptionType | 'UNDEFINED' | 'ONLINE' | 'OFFLINE';
+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"
+}
+/** @enumType */
+type V1SubscriptionStatusEnumSubscriptionStatusWithLiterals = V1SubscriptionStatusEnumSubscriptionStatus | 'UNDEFINED' | 'DRAFT' | 'PENDING' | 'ACTIVE' | 'EXPIRED' | 'CANCELED' | 'PENDING_CANCELLATION' | 'SUSPENDED';
+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"
+}
+/** @enumType */
+type PaymentStatusEnumPaymentStatusWithLiterals = PaymentStatusEnumPaymentStatus | 'UNDEFINED' | 'PAID' | 'REFUNDED' | 'FAILED' | 'UNPAID' | '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.
+ */
+interface V2Subscription {
+    /** frequency of recurring payment (required) */
+    frequency?: SubscriptionFrequencyWithLiterals;
+    /** 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 */
+declare enum SubscriptionFrequency {
+    UNDEFINED = "UNDEFINED",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+/** @enumType */
+type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
+/** Trial period of subscription */
+interface SubscriptionTrialPeriod {
+    /** trial period in units (required) */
+    period?: number;
+    /** units in which trial period is described (optional, default DAY) */
+    unit?: SubscriptionFrequencyWithLiterals;
+}
+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"
+}
+/** @enumType */
+type CancellationInitiatorWithLiterals = CancellationInitiator | 'UNDEFINED' | 'OWNER' | 'MEMBER' | 'PAYMENT_FAILURE' | 'SETUP_FAILURE';
+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;
+}
+interface Suspension {
+    status?: StatusWithLiterals;
+    /** Beginning of the suspended period */
+    startsAt?: Date | null;
+    /** End of the suspended period */
+    endsAt?: Date | null;
+}
+declare enum Status {
+    UNDEFINED = "UNDEFINED",
+    ACTIVE = "ACTIVE",
+    ENDED = "ENDED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNDEFINED' | 'ACTIVE' | 'ENDED';
+/** A duration expressed in amount of time units. */
+interface V1Duration {
+    /** Amount of the unit */
+    amount?: number;
+    /** Day, Week, Month, Year. */
+    unit?: SubscriptionFrequencyWithLiterals;
+}
+interface V1SubscriptionActivated {
+    subscription?: V1Subscription;
+}
+interface V1SubscriptionCanceled {
+    subscription?: V1Subscription;
+}
+interface V1SubscriptionUpdated {
+    subscription?: V1Subscription;
+}
+interface SubscriptionCycleTriggered {
+    subscription?: V1Subscription;
+    billingCycle?: number;
+    /**
+     * Wix Pay transaction id, optional. Exists if event was triggered by a payment.
+     * @format GUID
+     */
+    transactionId?: string | null;
+}
+interface SubscriptionMarkedAsPaid {
+    subscription?: V1Subscription;
+    /** A number indicating which payment (cycle) was marked as paid. For recurring subscriptions only. */
+    billingCycle?: number | null;
+}
+interface SubscriptionCancellationRequested {
+    subscription?: V1Subscription;
+}
+interface SubscriptionSuspended {
+    subscription?: V1Subscription;
+}
+interface V1SubscriptionResumed {
+    subscription?: V1Subscription;
+}
+interface SubscriptionExpired {
+    subscription?: V1Subscription;
+}
+interface V1SubscriptionInitialPurchaseCompleted {
+    subscription?: V1Subscription;
+}
+interface ListSubscriptionHistoryRequest {
+    /** @format GUID */
+    subscriptionId: string;
+    /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
+    mode?: HistoryViewModeWithLiterals;
+    /** Cursor for efficient paging. If paging through results, pass this field from the previous search response to continue to the next page. */
+    cursor?: CursorPaging;
+}
+declare enum HistoryViewMode {
+    UNKNOWN = "UNKNOWN",
+    /** Comprehensive view including all history events. */
+    BACKOFFICE = "BACKOFFICE",
+    /** User-centric view of the history. */
+    USER = "USER"
+}
+/** @enumType */
+type HistoryViewModeWithLiterals = HistoryViewMode | 'UNKNOWN' | 'BACKOFFICE' | 'USER';
+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;
+}
+interface SubscriptionHistoryEntry {
+    /** @format GUID */
+    entryId?: string;
+    /** TODO: add max length? it is not defined in domainevents, so should we? */
+    slug?: string;
+    entryTime?: Date | null;
+    event?: SubscriptionEvent;
+}
+interface SubscriptionEvent extends SubscriptionEventPayloadOneOf {
+    created?: SubscriptionCreated;
+    updated?: SubscriptionUpdated;
+    deleted?: SubscriptionDeleted;
+    activated?: SubscriptionActivated;
+    ended?: SubscriptionEnded;
+    canceled?: SubscriptionCanceled;
+    paused?: SubscriptionPaused;
+    resumed?: SubscriptionResumed;
+    pauseRequested?: PauseSubscriptionRequested;
+    resumeRequested?: ResumeSubscriptionRequested;
+    scheduledPauseCanceled?: ScheduledPauseCanceled;
+    scheduledResumeCanceled?: ScheduledResumeCanceled;
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+    autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
+    autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
+    cycleReadyToPay?: SubscriptionCycleReadyToPay;
+    extended?: SubscriptionExtended;
+    initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
+    latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
+    revived?: SubscriptionRevived;
+    billingDateUpdated?: SubscriptionBillingDateUpdated;
+    futureUpdatesRequested?: FutureUpdatesRequested;
+    updatesApplied?: UpdatesApplied;
+    resetPendingUpdates?: ResetPendingUpdates;
+    gracePeriodStarted?: GracePeriodStarted;
+    gracePeriodEnded?: GracePeriodEnded;
+    paymentMethodUpdated?: PaymentMethodUpdated;
+    collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
+    freeTrailStarted?: FreeTrailStarted;
+    freeTrailEnded?: FreeTrailEnded;
+    billingCyclePaid?: SubscriptionBillingCyclePaid;
+    initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
+    futurePriceUpdatesRequested?: FuturePriceUpdatesRequested;
+    subscriptionBoAction?: SubscriptionBackOfficeAction;
+    unknown?: UnknownSubscriptionEvent;
+}
+/** @oneof */
+interface SubscriptionEventPayloadOneOf {
+    created?: SubscriptionCreated;
+    updated?: SubscriptionUpdated;
+    deleted?: SubscriptionDeleted;
+    activated?: SubscriptionActivated;
+    ended?: SubscriptionEnded;
+    canceled?: SubscriptionCanceled;
+    paused?: SubscriptionPaused;
+    resumed?: SubscriptionResumed;
+    pauseRequested?: PauseSubscriptionRequested;
+    resumeRequested?: ResumeSubscriptionRequested;
+    scheduledPauseCanceled?: ScheduledPauseCanceled;
+    scheduledResumeCanceled?: ScheduledResumeCanceled;
+    billingCycleStarted?: SubscriptionBillingCycleStarted;
+    autoRenewalTurnedOn?: SubscriptionAutoRenewalTurnedOn;
+    autoRenewalTurnedOff?: SubscriptionAutoRenewalTurnedOff;
+    cycleReadyToPay?: SubscriptionCycleReadyToPay;
+    extended?: SubscriptionExtended;
+    initialPurchaseCompleted?: SubscriptionInitialPurchaseCompleted;
+    latestInvoiceMarkedAsPaid?: LatestInvoiceMarkedAsPaid;
+    revived?: SubscriptionRevived;
+    billingDateUpdated?: SubscriptionBillingDateUpdated;
+    futureUpdatesRequested?: FutureUpdatesRequested;
+    updatesApplied?: UpdatesApplied;
+    resetPendingUpdates?: ResetPendingUpdates;
+    gracePeriodStarted?: GracePeriodStarted;
+    gracePeriodEnded?: GracePeriodEnded;
+    paymentMethodUpdated?: PaymentMethodUpdated;
+    collectionMethodUpdated?: SubscriptionCollectionMethodUpdated;
+    freeTrailStarted?: FreeTrailStarted;
+    freeTrailEnded?: FreeTrailEnded;
+    billingCyclePaid?: SubscriptionBillingCyclePaid;
+    initiatePaymentMethodSetup?: InitiatedPaymentMethodSetup;
+    futurePriceUpdatesRequested?: FuturePriceUpdatesRequested;
+    subscriptionBoAction?: SubscriptionBackOfficeAction;
+    unknown?: UnknownSubscriptionEvent;
+}
+interface SubscriptionCreated {
+    subscription?: Subscription;
+}
+interface SubscriptionUpdated {
+    current?: Subscription;
+    previous?: Subscription;
+    diff?: SubscriptionDiff;
+}
+interface SubscriptionDiff {
+    added?: string | null;
+    changed?: string | null;
+    deleted?: string | null;
+}
+interface SubscriptionDeleted {
+    subscriptionId?: string;
+}
+interface FutureUpdatesRequested {
+    subscription?: Subscription;
+    requestedUpdateData?: SubscriptionUpdateData;
+}
+interface UpdatesApplied {
+    subscription?: Subscription;
+    updateAction?: UpdateActionWithLiterals;
+    appliedUpdateData?: SubscriptionUpdateData;
+}
+interface ResetPendingUpdates {
+    subscription?: Subscription;
+}
+interface GracePeriodStarted {
+    subscription?: Subscription;
+}
+interface GracePeriodEnded {
+    subscription?: Subscription;
+    /** Indication for the payment settlement method. */
+    paymentSettlementMethod?: PaymentSettlementMethodWithLiterals;
+}
+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"
+}
+/** @enumType */
+type PaymentSettlementMethodWithLiterals = PaymentSettlementMethod | 'UNKNOWN' | 'SYSTEM' | 'MARK_AS_PAID' | 'CUSTOMER_PAY_NOW';
+interface PaymentMethodUpdated {
+    subscription?: Subscription;
+    initiator?: HistoryActionInitiatorWithLiterals;
+    paymentMode?: PaymentModeWithLiterals;
+}
+interface SubscriptionCollectionMethodUpdated {
+    subscription?: Subscription;
+    newCollectionMethod?: CollectionMethodEnumCollectionMethodWithLiterals;
+    previousCollectionMethod?: CollectionMethodEnumCollectionMethodWithLiterals;
+}
+interface FreeTrailStarted {
+    subscription?: Subscription;
+}
+interface FreeTrailEnded {
+    subscription?: Subscription;
+}
+interface InitiatedPaymentMethodSetup {
+    subscription?: Subscription;
+}
+interface FuturePriceUpdatesRequested {
+    subscription?: Subscription;
+    requestedUpdateData?: SubscriptionUpdateData;
+}
+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 */
+interface UnknownSubscriptionEvent {
+    subscriptionAsString?: string | null;
+}
+/** @docsIgnore */
+type CustomerCancelSubscriptionApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CustomerTurnOnSubscriptionAutoRenewalApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CustomerTurnOffSubscriptionAutoRenewalApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CustomerExtendSubscriptionApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type UpdateSubscriptionBillingDateApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type CancelSubscriptionApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type PauseSubscriptionApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type ResumeSubscriptionApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type TurnOnSubscriptionAutoRenewalApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type TurnOffSubscriptionAutoRenewalApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type MarkLatestInvoiceAsPaidApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUBSCRIPTION_PART_OF_ORDER';
+    description?: string;
+    data?: MultipleSubscriptionsOnOrdersInvoice;
+};
+/** @docsIgnore */
+type MarkBillingCycleAsPaidApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'SUBSCRIPTION_PART_OF_ORDER';
+    description?: string;
+    data?: MultipleSubscriptionsOnOrdersInvoice;
+} | {
+    code?: 'INVOICE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_COLLECTION_METHOD';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type ExtendSubscriptionApplicationErrors = {
+    code?: 'OPERATION_NOT_SUPPORTED_FOR_STATUS';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface SubscriptionCanceledEnvelope {
+    data: SubscriptionCanceled;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription is canceled.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_canceled
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService
+ * @slug canceled
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionCanceled(handler: (event: SubscriptionCanceledEnvelope) => void | Promise<void>): void;
+interface SubscriptionExtendedEnvelope {
+    data: SubscriptionExtended;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when subscription has been extended
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_extended
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService
+ * @slug extended
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionExtended(handler: (event: SubscriptionExtendedEnvelope) => void | Promise<void>): void;
+interface SubscriptionUpdatedEnvelope {
+    entity: Subscription;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription is updated.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_updated
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionUpdated(handler: (event: SubscriptionUpdatedEnvelope) => void | Promise<void>): void;
+interface SubscriptionAutoRenewalTurnedOffEnvelope {
+    data: SubscriptionAutoRenewalTurnedOff;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription cycleAutoRenew was turned off.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_auto_renewal_turned_off
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug auto_renewal_turned_off
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionAutoRenewalTurnedOff(handler: (event: SubscriptionAutoRenewalTurnedOffEnvelope) => void | Promise<void>): void;
+interface SubscriptionAutoRenewalTurnedOnEnvelope {
+    data: SubscriptionAutoRenewalTurnedOn;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription cycleAutoRenew was turned on.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_auto_renewal_turned_on
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug auto_renewal_turned_on
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionAutoRenewalTurnedOn(handler: (event: SubscriptionAutoRenewalTurnedOnEnvelope) => void | Promise<void>): void;
+interface SubscriptionBillingDateUpdatedEnvelope {
+    data: SubscriptionBillingDateUpdated;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when subscription has been extended
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_billing_date_updated
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug billing_date_updated
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionBillingDateUpdated(handler: (event: SubscriptionBillingDateUpdatedEnvelope) => void | Promise<void>): void;
+interface SubscriptionLatestInvoiceMarkedAsPaidEnvelope {
+    data: LatestInvoiceMarkedAsPaid;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_latest_invoice_marked_as_paid
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug latest_invoice_marked_as_paid
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionLatestInvoiceMarkedAsPaid(handler: (event: SubscriptionLatestInvoiceMarkedAsPaidEnvelope) => void | Promise<void>): void;
+interface SubscriptionPauseScheduleCanceledEnvelope {
+    data: ScheduledPauseCanceled;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when scheduled pause canceled
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_pause_schedule_canceled
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug pause_schedule_canceled
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionPauseScheduleCanceled(handler: (event: SubscriptionPauseScheduleCanceledEnvelope) => void | Promise<void>): void;
+interface SubscriptionPauseScheduledEnvelope {
+    data: PauseSubscriptionRequested;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when pause subscription requested
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_pause_scheduled
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug pause_scheduled
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionPauseScheduled(handler: (event: SubscriptionPauseScheduledEnvelope) => void | Promise<void>): void;
+interface SubscriptionPausedEnvelope {
+    data: SubscriptionPaused;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription is paused.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_paused
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug paused
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionPaused(handler: (event: SubscriptionPausedEnvelope) => void | Promise<void>): void;
+interface SubscriptionResumeScheduleCanceledEnvelope {
+    data: ScheduledResumeCanceled;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when scheduled pause canceled
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_resume_schedule_canceled
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug resume_schedule_canceled
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionResumeScheduleCanceled(handler: (event: SubscriptionResumeScheduleCanceledEnvelope) => void | Promise<void>): void;
+interface SubscriptionResumeScheduledEnvelope {
+    data: ResumeSubscriptionRequested;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when resume subscription requested
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_resume_scheduled
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug resume_scheduled
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionResumeScheduled(handler: (event: SubscriptionResumeScheduledEnvelope) => void | Promise<void>): void;
+interface SubscriptionResumedEnvelope {
+    data: SubscriptionResumed;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a subscription is resumed.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId subscriptions.view
+ * @webhook
+ * @eventType wix.billing.v1.subscription_resumed
+ * @serviceIdentifier com.wixpress.billing.subscriptions.api.v1.SubscriptionsService
+ * @slug resumed
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionResumed(handler: (event: SubscriptionResumedEnvelope) => void | Promise<void>): void;
+/**
+ * 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
+ */
+declare function customerGetSubscription(_id: string): Promise<NonNullablePaths<GetSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
+/**
+ * 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
+ */
+declare function customerCancelSubscription(_id: string, options?: CustomerCancelSubscriptionOptions): Promise<NonNullablePaths<CustomerCancelSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: CustomerCancelSubscriptionApplicationErrors;
+}>;
+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
+ */
+declare function customerTurnOnSubscriptionAutoRenewal(_id: string, options?: CustomerTurnOnSubscriptionAutoRenewalOptions): Promise<NonNullablePaths<CustomerTurnOnAutoRenewalResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: CustomerTurnOnSubscriptionAutoRenewalApplicationErrors;
+}>;
+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
+ */
+declare function customerTurnOffSubscriptionAutoRenewal(_id: string, options?: CustomerTurnOffSubscriptionAutoRenewalOptions): Promise<NonNullablePaths<CustomerTurnOffAutoRenewalResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: CustomerTurnOffSubscriptionAutoRenewalApplicationErrors;
+}>;
+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
+ */
+declare function customerExtendSubscription(_id: string, options?: NonNullablePaths<CustomerExtendSubscriptionOptions, `billingCyclesToAdd`, 2>): Promise<NonNullablePaths<CustomerExtendSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: CustomerExtendSubscriptionApplicationErrors;
+}>;
+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
+     * @min 1
+     */
+    billingCyclesToAdd: number | null;
+}
+/**
+ * identity must be a site member
+ * @public
+ * @documentationMaturity preview
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.QuerySubscriptions
+ */
+declare function customerQuerySubscriptions(options?: CustomerQuerySubscriptionsOptions): Promise<NonNullablePaths<QuerySubscriptionsResponse, `subscriptions` | `subscriptions.${number}.name` | `subscriptions.${number}.customer.visitorId` | `subscriptions.${number}.customer.contactId` | `subscriptions.${number}.customer.memberId` | `subscriptions.${number}.customer.accountId` | `subscriptions.${number}.status` | `subscriptions.${number}.billingSettings.currency` | `subscriptions.${number}.billingSettings.paymentMethod._id` | `subscriptions.${number}.billingSettings.collectionMethod` | `subscriptions.${number}.billingSettings.cycleDuration.unit` | `subscriptions.${number}.billingSettings.cycleAutoRenew` | `subscriptions.${number}.billingSettings.taxSettings.inclusive` | `subscriptions.${number}.billingSettings.shippingCharges.amount` | `subscriptions.${number}.billingSettings.externalCollectionDetails.collectorName` | `subscriptions.${number}.billingStatus.currentCycle` | `subscriptions.${number}.billingStatus.latestPaymentData.invoiceId` | `subscriptions.${number}.billingStatus.latestPaymentData.paymentStatus` | `subscriptions.${number}.policies.customerCanCancel` | `subscriptions.${number}.policies.businessCanExtend` | `subscriptions.${number}.policies.allowEndOfCycleCancellation` | `subscriptions.${number}.pauseInfo.pausePolicy` | `subscriptions.${number}.pauseInfo.pauseAt` | `subscriptions.${number}.pauseInfo.resumeAt` | `subscriptions.${number}.cancellationInfo.initiator` | `subscriptions.${number}.pendingUpdateData.numberOfRequests`, 6>>;
+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
+ */
+declare function customerUpdateSubscriptionPaymentMethod(_id: string, paymentMethodId: string): Promise<NonNullablePaths<UpdateSubscriptionPaymentMethodResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
+/** @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.AllowedActions
+ */
+declare function customerAllowedActions(_id: string): Promise<NonNullablePaths<CustomerAllowedActionsResponse, `actions` | `actions.${number}.actionType`, 4>>;
+/**
+ * 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
+ */
+declare function customerListUpcomingCharges(_id: string): Promise<NonNullablePaths<CustomerListUpcomingChargesResponse, `upcomingCharge.cycle` | `upcomingCharge.totals.totalPrice` | `upcomingCharge.totals.subtotal` | `upcomingCharge.invoiceItems` | `upcomingCharge.invoiceItems.${number}.recurring.cycleNumber` | `upcomingCharge.invoiceItems.${number}._id` | `upcomingCharge.invoiceItems.${number}.name` | `upcomingCharge.invoiceItems.${number}.catalogReference.catalogItemId` | `upcomingCharge.invoiceItems.${number}.category` | `upcomingCharge.invoiceItems.${number}.quantity` | `upcomingCharge.invoiceItems.${number}.priceDetails.price` | `upcomingCharge.invoiceItems.${number}.priceDetails.tax.amount` | `upcomingCharge.invoiceItems.${number}.priceDetails.tax.percentage` | `upcomingCharge.invoiceItems.${number}.priceDetails.discount.amount` | `upcomingCharge.invoiceItems.${number}.priceDetails.discount.percentage` | `upcomingCharge.invoiceItems.${number}.priceDetails.applicationFeeDetails.amount` | `upcomingCharge.invoiceItems.${number}.taxData.lineItemTaxSummary.aggregatedTaxAmount` | `upcomingCharge.invoiceItems.${number}.taxData.lineItemTaxSummary.aggregatedTaxRate` | `upcomingCharge.invoiceItems.${number}.taxData.lineItemTaxSummary.taxableAmount`, 7>>;
+/**
+ * Creates auto-charge order that can be paid by customer
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.InitiatePaymentMethodSetup
+ */
+declare function customerInitiatePaymentMethodSetup(_id: string, options?: CustomerInitiatePaymentMethodSetupOptions): Promise<NonNullablePaths<InitiatePaymentMethodSetupResponse, `paymentOrderId`, 2>>;
+interface CustomerInitiatePaymentMethodSetupOptions {
+    paymentMode?: PaymentModeWithLiterals;
+    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
+ */
+declare function payCycle(subscriptionId: string, options?: NonNullablePaths<PayCycleOptions, `tenantId`, 2>): Promise<NonNullablePaths<PayCycleResponse, `invoiceId` | `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
+interface PayCycleOptions {
+    paymentTestMode?: PaymentTestModeWithLiterals;
+    /** @format GUID */
+    tenantId: string;
+}
+/**
+ * Returns a single subscription by its id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId subscriptions.view
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.GetSubscription
+ */
+declare function getSubscription(_id: string): Promise<NonNullablePaths<GetSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
+/**
+ * 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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.UpdateSubscriptionPaymentMethod
+ */
+declare function updateSubscriptionPaymentMethod(_id: string, paymentMethodId: string): Promise<NonNullablePaths<UpdateSubscriptionPaymentMethodResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8>>;
+/**
+ * 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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.UpdateSubscriptionBillingDate
+ */
+declare function updateSubscriptionBillingDate(_id: string, billingDate: Date, options?: UpdateSubscriptionBillingDateOptions): Promise<NonNullablePaths<UpdateSubscriptionBillingDateResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: UpdateSubscriptionBillingDateApplicationErrors;
+}>;
+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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.CancelSubscription
+ */
+declare function cancelSubscription(_id: string, actionContext: ActionContext): Promise<NonNullablePaths<CancelSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: CancelSubscriptionApplicationErrors;
+}>;
+/**
+ * Pauses subscription now or in future. Possible to pause also payments schedule.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField options.actionContext
+ * @permissionId subscriptions.manage
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.PauseSubscription
+ */
+declare function pauseSubscription(_id: string, options?: NonNullablePaths<PauseSubscriptionOptions, `actionContext`, 2>): Promise<NonNullablePaths<PauseSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: PauseSubscriptionApplicationErrors;
+}>;
+interface PauseSubscriptionOptions {
+    pausePolicy?: PausePolicyWithLiterals;
+    pauseAt?: PauseAtWithLiterals;
+    /** 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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.ResumeSubscription
+ */
+declare function resumeSubscription(_id: string, options?: NonNullablePaths<ResumeSubscriptionOptions, `actionContext`, 2>): Promise<NonNullablePaths<ResumeSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: ResumeSubscriptionApplicationErrors;
+}>;
+interface ResumeSubscriptionOptions {
+    resumeAt?: ResumeAtWithLiterals;
+    /** 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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.QuerySubscriptions
+ */
+declare function querySubscriptions(query: QueryV2): Promise<NonNullablePaths<QuerySubscriptionsResponse, `subscriptions` | `subscriptions.${number}.name` | `subscriptions.${number}.customer.visitorId` | `subscriptions.${number}.customer.contactId` | `subscriptions.${number}.customer.memberId` | `subscriptions.${number}.customer.accountId` | `subscriptions.${number}.status` | `subscriptions.${number}.billingSettings.currency` | `subscriptions.${number}.billingSettings.paymentMethod._id` | `subscriptions.${number}.billingSettings.collectionMethod` | `subscriptions.${number}.billingSettings.cycleDuration.unit` | `subscriptions.${number}.billingSettings.cycleAutoRenew` | `subscriptions.${number}.billingSettings.taxSettings.inclusive` | `subscriptions.${number}.billingSettings.shippingCharges.amount` | `subscriptions.${number}.billingSettings.externalCollectionDetails.collectorName` | `subscriptions.${number}.billingStatus.currentCycle` | `subscriptions.${number}.billingStatus.latestPaymentData.invoiceId` | `subscriptions.${number}.billingStatus.latestPaymentData.paymentStatus` | `subscriptions.${number}.policies.customerCanCancel` | `subscriptions.${number}.policies.businessCanExtend` | `subscriptions.${number}.policies.allowEndOfCycleCancellation` | `subscriptions.${number}.pauseInfo.pausePolicy` | `subscriptions.${number}.pauseInfo.pauseAt` | `subscriptions.${number}.pauseInfo.resumeAt` | `subscriptions.${number}.cancellationInfo.initiator` | `subscriptions.${number}.pendingUpdateData.numberOfRequests`, 6>>;
+/** @public
+ * @documentationMaturity preview
+ * @permissionId subscriptions.view
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.SearchSubscriptions
+ */
+declare function searchSubscriptions(options?: SearchSubscriptionsOptions): Promise<NonNullablePaths<SearchSubscriptionsResponse, `subscriptions` | `subscriptions.${number}.name` | `subscriptions.${number}.customer.visitorId` | `subscriptions.${number}.customer.contactId` | `subscriptions.${number}.customer.memberId` | `subscriptions.${number}.customer.accountId` | `subscriptions.${number}.status` | `subscriptions.${number}.billingSettings.currency` | `subscriptions.${number}.billingSettings.paymentMethod._id` | `subscriptions.${number}.billingSettings.collectionMethod` | `subscriptions.${number}.billingSettings.cycleDuration.unit` | `subscriptions.${number}.billingSettings.cycleAutoRenew` | `subscriptions.${number}.billingSettings.taxSettings.inclusive` | `subscriptions.${number}.billingSettings.shippingCharges.amount` | `subscriptions.${number}.billingSettings.externalCollectionDetails.collectorName` | `subscriptions.${number}.billingStatus.currentCycle` | `subscriptions.${number}.billingStatus.latestPaymentData.invoiceId` | `subscriptions.${number}.billingStatus.latestPaymentData.paymentStatus` | `subscriptions.${number}.policies.customerCanCancel` | `subscriptions.${number}.policies.businessCanExtend` | `subscriptions.${number}.policies.allowEndOfCycleCancellation` | `subscriptions.${number}.pauseInfo.pausePolicy` | `subscriptions.${number}.pauseInfo.pauseAt` | `subscriptions.${number}.pauseInfo.resumeAt` | `subscriptions.${number}.cancellationInfo.initiator` | `subscriptions.${number}.pendingUpdateData.numberOfRequests`, 6>>;
+interface SearchSubscriptionsOptions extends SearchSubscriptionsOptionsPagingMethodOneOf {
+    /** 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;
+}
+/** @oneof */
+interface SearchSubscriptionsOptionsPagingMethodOneOf {
+    /** 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;
+}
+/**
+ * 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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.CountSubscriptions
+ */
+declare function countSubscriptions(options?: CountSubscriptionsOptions): Promise<NonNullablePaths<CountSubscriptionsResponse, `countByStatus` | `countByStatus.${number}.status` | `countByStatus.${number}.count` | `total`, 4>>;
+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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.TurnOnSubscriptionAutoRenewal
+ */
+declare function turnOnSubscriptionAutoRenewal(_id: string, actionContext: ActionContext): Promise<NonNullablePaths<TurnOnSubscriptionAutoRenewalResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: TurnOnSubscriptionAutoRenewalApplicationErrors;
+}>;
+/**
+ * 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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.TurnOffSubscriptionAutoRenewal
+ */
+declare function turnOffSubscriptionAutoRenewal(_id: string, actionContext: ActionContext): Promise<NonNullablePaths<TurnOffSubscriptionAutoRenewalResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: TurnOffSubscriptionAutoRenewalApplicationErrors;
+}>;
+/**
+ * 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
+ * @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
+ */
+declare function markLatestInvoiceAsPaid(subscriptionId: string): Promise<NonNullablePaths<MarkLatestInvoiceAsPaidResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: MarkLatestInvoiceAsPaidApplicationErrors;
+}>;
+/**
+ * Marks the invoice associated with given subscription cycle as paid for the following scenarios:
+ * 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
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.MarkBillingCycleAsPaid
+ */
+declare function markBillingCycleAsPaid(subscriptionId: string, options?: MarkBillingCycleAsPaidOptions): Promise<NonNullablePaths<MarkBillingCycleAsPaidResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: MarkBillingCycleAsPaidApplicationErrors;
+}>;
+interface MarkBillingCycleAsPaidOptions {
+    /**
+     * The subscription cycle for which the invoice is to be marked as paid.
+     * If left empty, the most recent cycle will be selected.
+     * @min 1
+     */
+    paidCycle?: number | null;
+}
+/**
+ * Returns number of subscriptions in each state.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId subscriptions.view
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.GetSubscriptionsStats
+ */
+declare function getSubscriptionsStats(): Promise<NonNullablePaths<GetSubscriptionsStatsResponse, `amountByStatuses` | `amountByStatuses.${number}.status` | `amountByStatuses.${number}.amount` | `total`, 4>>;
+/**
+ * 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
+ * @requiredField options
+ * @requiredField options.extendPolicy
+ * @permissionId subscriptions.manage
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.ExtendSubscription
+ */
+declare function extendSubscription(_id: string, actionContext: ActionContext, options: ExtendSubscriptionOptions): Promise<NonNullablePaths<ExtendSubscriptionResponse, `subscription.name` | `subscription.customer.visitorId` | `subscription.customer.contactId` | `subscription.customer.memberId` | `subscription.customer.accountId` | `subscription.status` | `subscription.billingSettings.currency` | `subscription.billingSettings.paymentMethod._id` | `subscription.billingSettings.collectionMethod` | `subscription.billingSettings.cycleDuration.unit` | `subscription.billingSettings.cycleAutoRenew` | `subscription.billingSettings.billingAddress.address.streetAddress.number` | `subscription.billingSettings.billingAddress.address.streetAddress.name` | `subscription.billingSettings.taxSettings.inclusive` | `subscription.billingSettings.additionalFees` | `subscription.billingSettings.additionalFees.${number}.name` | `subscription.billingSettings.additionalFees.${number}.amount` | `subscription.billingSettings.additionalFees.${number}.trigger` | `subscription.billingSettings.additionalFees.${number}.tax.amount` | `subscription.billingSettings.additionalFees.${number}.tax.percentage` | `subscription.billingSettings.additionalFees.${number}.tax.dynamic.taxableAddressType` | `subscription.billingSettings.additionalFees.${number}.cycles.cycleFrom` | `subscription.billingSettings.additionalFees.${number}.origin.appId` | `subscription.billingSettings.additionalFees.${number}.origin.entityId` | `subscription.billingSettings.shippingCharges.amount` | `subscription.billingSettings.shippingCharges.discounts` | `subscription.billingSettings.shippingCharges.discounts.${number}.amount` | `subscription.billingSettings.shippingCharges.discounts.${number}.percentage` | `subscription.billingSettings.shippingCharges.discounts.${number}.cycles.cycleFrom` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.appId` | `subscription.billingSettings.shippingCharges.discounts.${number}.origin.entityId` | `subscription.billingSettings.discounts` | `subscription.billingSettings.externalCollectionDetails.collectorName` | `subscription.billingStatus.currentCycle` | `subscription.billingStatus.latestPaymentData.invoiceId` | `subscription.billingStatus.latestPaymentData.paymentStatus` | `subscription.billingStatus.latestPaymentData.totals.totalPrice` | `subscription.billingStatus.latestPaymentData.totals.subtotal` | `subscription.billingStatus.gracePeriodData.automaticRetryData.enabled` | `subscription.policies.customerCanCancel` | `subscription.policies.businessCanExtend` | `subscription.policies.allowEndOfCycleCancellation` | `subscription.pauseInfo.pausePolicy` | `subscription.pauseInfo.pauseAt` | `subscription.pauseInfo.resumeAt` | `subscription.cancellationInfo.initiator` | `subscription.pendingUpdateData.itemsToUpdate` | `subscription.pendingUpdateData.itemsToUpdate.${number}._id` | `subscription.pendingUpdateData.itemsToUpdate.${number}.pricingModel.fixedPrice.itemPrice` | `subscription.pendingUpdateData.itemsToAdd` | `subscription.pendingUpdateData.itemsToAdd.${number}.name` | `subscription.pendingUpdateData.itemsToAdd.${number}.catalogReference.catalogItemId` | `subscription.pendingUpdateData.itemsToAdd.${number}.category` | `subscription.pendingUpdateData.itemsToAdd.${number}.quantity` | `subscription.pendingUpdateData.itemsToAdd.${number}.applicationFee.amount` | `subscription.pendingUpdateData.itemsToDelete` | `subscription.pendingUpdateData.numberOfRequests` | `subscription.items`, 8> & {
+    __applicationErrorsType?: ExtendSubscriptionApplicationErrors;
+}>;
+interface ExtendSubscriptionOptions extends ExtendSubscriptionOptionsExtendPolicyOneOf {
+    /** User won't be charged for additional period added on top of subscription end date. */
+    extensionPeriod?: Duration;
+    /**
+     * user will be charged for billing cycles added
+     * @min 1
+     */
+    extensionBillingCycles?: number;
+}
+/** @oneof */
+interface ExtendSubscriptionOptionsExtendPolicyOneOf {
+    /** User won't be charged for additional period added on top of subscription end date. */
+    extensionPeriod?: Duration;
+    /**
+     * user will be charged for billing cycles added
+     * @min 1
+     */
+    extensionBillingCycles?: number;
+}
+/** @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId subscriptions.manage
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.AllowedActions
+ */
+declare function allowedActions(_id: string, options?: AllowedActionsOptions): Promise<NonNullablePaths<AllowedActionsResponse, `actions` | `actions.${number}.actionType` | `unsupportedActions` | `unsupportedActions.${number}.actionType`, 4>>;
+interface AllowedActionsOptions {
+    /**
+     * List of additional fields to be included in the response.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/**
+ * List future subscriptions charges
+ * @param subscriptionId - Subscription id charges to be previewed for
+ * @public
+ * @documentationMaturity preview
+ * @requiredField subscriptionId
+ * @permissionId subscriptions.view
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.ListUpcomingCharges
+ */
+declare function listUpcomingCharges(subscriptionId: string, options?: ListUpcomingChargesOptions): Promise<NonNullablePaths<ListUpcomingChargesResponse, `upcomingCharges` | `upcomingCharges.${number}.cycle` | `upcomingCharges.${number}.totals.totalPrice` | `upcomingCharges.${number}.totals.subtotal` | `upcomingCharges.${number}.discount.amount` | `upcomingCharges.${number}.discount.percentage` | `upcomingCharges.${number}.discount.origin.appId` | `upcomingCharges.${number}.discount.origin.entityId`, 6>>;
+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.subscription.subscriptionInfo
+ * @requiredField options.subscription.subscriptionInfo.billingSettings
+ * @requiredField options.subscription.subscriptionInfo.items
+ * @requiredField options.subscription.subscriptionInfo.items.pricingModel
+ * @permissionId subscriptions.view
+ * @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
+ */
+declare function previewSubscriptionCharges(options?: PreviewSubscriptionChargesOptions): Promise<NonNullablePaths<PreviewSubscriptionChargesResponse, `charges` | `charges.${number}.cycleFrom` | `charges.${number}.totals.totalPrice` | `charges.${number}.totals.subtotal`, 5>>;
+interface PreviewSubscriptionChargesOptions extends PreviewSubscriptionChargesOptionsSubscriptionOneOf {
+    /** Information about a non-existing subscription. */
+    subscriptionInfo?: SubscriptionInfo;
+}
+/** @oneof */
+interface PreviewSubscriptionChargesOptionsSubscriptionOneOf {
+    /** 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.externalId
+ * @requiredField options.subscriptionsBillingDetails.items
+ * @requiredField options.subscriptionsBillingDetails.items.pricingModel
+ * @permissionId subscriptions.view
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.PreviewSubscriptionsCharges
+ */
+declare function previewSubscriptionsCharges(options?: NonNullablePaths<PreviewSubscriptionsChargesOptions, `subscriptionsBillingDetails.${number}.billingSettings` | `subscriptionsBillingDetails.${number}.externalId` | `subscriptionsBillingDetails.${number}.items` | `subscriptionsBillingDetails.${number}.items.${number}.pricingModel`, 6>): Promise<NonNullablePaths<PreviewSubscriptionsChargesResponse, `subscriptionsCharges`, 2>>;
+interface PreviewSubscriptionsChargesOptions {
+    /**
+     * Information required to calculate the preview charges for the subscriptions, including an identifier.
+     * @minSize 1
+     * @maxSize 10
+     */
+    subscriptionsBillingDetails?: SubscriptionBillingDetails[];
+    /**
+     * Specifies the number of upcoming billing charges to preview for all subscriptions in the order.
+     * 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.
+     * @min 1
+     * @max 10
+     */
+    numberOfNextRecurringCharges?: number | null;
+}
+/**
+ * Creates authorization invoice with Moto settings in order to create
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId subscriptions.manage
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.InitiatePaymentMethodSetup
+ */
+declare function initiatePaymentMethodSetup(_id: string, options?: InitiatePaymentMethodSetupOptions): Promise<NonNullablePaths<InitiatePaymentMethodSetupResponse, `paymentOrderId`, 2>>;
+interface InitiatePaymentMethodSetupOptions {
+    paymentMode?: PaymentModeWithLiterals;
+    paymentSettings?: PaymentSettings;
+}
+/** @public
+ * @documentationMaturity preview
+ * @requiredField subscriptionId
+ * @permissionId subscriptions.view
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionHistoryService.ListSubscriptionHistory
+ */
+declare function listSubscriptionHistory(subscriptionId: string, options?: ListSubscriptionHistoryOptions): Promise<NonNullablePaths<ListSubscriptionHistoryResponse, `historyEntries` | `historyEntries.${number}.entryId` | `historyEntries.${number}.slug` | `historyEntries.${number}.event.deleted.subscriptionId` | `historyEntries.${number}.event.paused.pausePolicy` | `historyEntries.${number}.event.pauseRequested.pauseAt` | `historyEntries.${number}.event.pauseRequested.pausePolicy` | `historyEntries.${number}.event.resumeRequested.resumeAt` | `historyEntries.${number}.event.extended.extensionBillingCycles` | `historyEntries.${number}.event.updatesApplied.updateAction` | `historyEntries.${number}.event.gracePeriodEnded.paymentSettlementMethod` | `historyEntries.${number}.event.paymentMethodUpdated.initiator` | `historyEntries.${number}.event.paymentMethodUpdated.paymentMode` | `historyEntries.${number}.event.collectionMethodUpdated.newCollectionMethod` | `historyEntries.${number}.event.collectionMethodUpdated.previousCollectionMethod` | `historyEntries.${number}.event.billingCyclePaid.paidCycle` | `historyEntries.${number}.event.billingCyclePaid.invoiceId` | `historyEntries.${number}.event.subscriptionBoAction.name` | `historyEntries.${number}.event.subscriptionBoAction.params`, 6>>;
+interface ListSubscriptionHistoryOptions {
+    /** Determines the type of view for the history: either a comprehensive backoffice view or a user-centric view. */
+    mode?: HistoryViewModeWithLiterals;
+    /** 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 { type Action, type ActionContext, type ActionDetails, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, ActionType, type ActionTypeWithLiterals, type AddPausePeriodRequest, type AddPausePeriodResponse, type AdditionalFee, AdditionalFeeTrigger, type AdditionalFeeTriggerWithLiterals, type Address, type AddressStreetOneOf, type AggregatedTaxBreakdown, type AllowedActionsOptions, type AllowedActionsRequest, type AllowedActionsResponse, type AmountByStatus, type ApplicationFee, type ApplicationFeeValueOneOf, type AttachInvoice, type AutomaticRetryData, type BaseEventMetadata, type BillingSettings, type BillingStatus, type BulkItemChange, type BulkUpdateSubscriptionItemsByFilterRequest, type BulkUpdateSubscriptionItemsByFilterResponse, type BusinessOrigin, type BusinessOriginData, type Cancel, type CancelSubscriptionApplicationErrors, type CancelSubscriptionBORequest, type CancelSubscriptionBOResponse, type CancelSubscriptionRequest, type CancelSubscriptionResponse, type CancelTimeCapsuleTaskRequest, type CancellationInfo, CancellationInitiator, type CancellationInitiatorWithLiterals, type CatalogReference, type Charge, CollectionMethod, CollectionMethodEnumCollectionMethod, type CollectionMethodEnumCollectionMethodWithLiterals, type CollectionMethodWithLiterals, type Complete, type ConvertSapiRequest, type ConvertSapiResponse, type CountByStatus, type CountSubscriptionFilter, type CountSubscriptionFilterStatusOneOf, type CountSubscriptionsOptions, type CountSubscriptionsRequest, type CountSubscriptionsResponse, type CreateRecurringInvoiceBORequest, type CreateRecurringInvoiceBOResponse, type CreateSubscriptionForOrderRequest, type CreateSubscriptionForOrderResponse, type CreateSubscriptionInStateRequest, type CreateSubscriptionInStateRequestModeOneOf, type CreateSubscriptionInStateResponse, type CreateSubscriptionRequest, type CreateSubscriptionResponse, CreationMode, type CreationModeWithLiterals, type CursorPaging, type Cursors, type CustomBillingSchedule, type CustomProration, type CustomProrationAmountOneOf, type Customer, type CustomerAllowedActionsRequest, type CustomerAllowedActionsResponse, type CustomerCancelSubscriptionApplicationErrors, type CustomerCancelSubscriptionOptions, type CustomerCancelSubscriptionRequest, type CustomerCancelSubscriptionResponse, type CustomerExtendSubscriptionApplicationErrors, type CustomerExtendSubscriptionOptions, type CustomerExtendSubscriptionRequest, type CustomerExtendSubscriptionResponse, type CustomerIdOneOf, type CustomerInitiatePaymentMethodSetupOptions, type CustomerListUpcomingChargesRequest, type CustomerListUpcomingChargesResponse, type CustomerQuerySubscriptionsOptions, type CustomerTurnOffAutoRenewalRequest, type CustomerTurnOffAutoRenewalResponse, type CustomerTurnOffSubscriptionAutoRenewalApplicationErrors, type CustomerTurnOffSubscriptionAutoRenewalOptions, type CustomerTurnOnAutoRenewalRequest, type CustomerTurnOnAutoRenewalResponse, type CustomerTurnOnSubscriptionAutoRenewalApplicationErrors, type CustomerTurnOnSubscriptionAutoRenewalOptions, type Cycles, type DeleteDraftSubscriptionRequest, type DeleteDraftSubscriptionResponse, type DeleteSubscriptionBORequest, type DeleteSubscriptionBOResponse, type DeleteSubscriptionRequest, type DeleteSubscriptionResponse, type DetachInvoice, type Discount, type DiscountCycles, type DiscountOrigin, type DiscountValueOneOf, type DomainEvent, type DomainEventBodyOneOf, type Duration, DurationUnit, type DurationUnitWithLiterals, type DynamicTax, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, ExtendPolicyType, type ExtendPolicyTypeWithLiterals, type ExtendSubscriptionApplicationErrors, type ExtendSubscriptionOptions, type ExtendSubscriptionOptionsExtendPolicyOneOf, type ExtendSubscriptionRequest, type ExtendSubscriptionRequestExtendPolicyOneOf, type ExtendSubscriptionResponse, type ExternalCollectionDetails, type FinishFreeTrialNowRequest, type FinishFreeTrialNowResponse, type FixSubscriptionInvoicesRequest, type FixSubscriptionInvoicesRequestModeOneOf, type FixSubscriptionInvoicesResponse, type FixSubscriptionTimeCapsuleTasksRequest, type FixSubscriptionTimeCapsuleTasksResponse, type FixedPrice, type FreeTrailEnded, type FreeTrailStarted, type FreeTrialData, type FullAddressContactDetails, type FullAddressDetails, type FuturePriceUpdatesRequested, type FutureUpdatesRequested, type GetFullSubscriptionDataRequest, type GetFullSubscriptionDataResponse, type GetSubscriptionAndInternalDataRequest, type GetSubscriptionAndInternalDataResponse, type GetSubscriptionInvoicesRequest, type GetSubscriptionInvoicesResponse, type GetSubscriptionRequest, type GetSubscriptionResponse, type GetSubscriptionsStatsRequest, type GetSubscriptionsStatsResponse, type GracePeriodData, type GracePeriodEnded, type GracePeriodStarted, type HandleSubscriptionAfterInvoiceMarkedAsPaidRequest, HistoryActionInitiator, type HistoryActionInitiatorWithLiterals, HistoryViewMode, type HistoryViewModeWithLiterals, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, type IdentityTypeWithLiterals, type InitiatePaymentMethodSetupOptions, type InitiatePaymentMethodSetupRequest, type InitiatePaymentMethodSetupResponse, type InitiatedPaymentMethodSetup, type InternalSubscriptionData, type Invoice, type InvoiceAction, type InvoiceActionActionTypeOneOf, type InvoiceApplicationFee, type InvoiceApplicationFeeValueOneOf, type InvoiceDiscount, type InvoiceDiscountValueOneOf, type InvoiceItem, type InvoiceItemPaymentTypeOneOf, type InvoiceShippingCharges, InvoiceStatus, type InvoiceStatusWithLiterals, type Item, ItemCategory, type ItemCategoryWithLiterals, type ItemChange, type ItemTaxData, type LatestInvoiceMarkedAsPaid, type LatestPaymentAttempt, type LineItemTaxSummary, type ListSubscriptionHistoryOptions, type ListSubscriptionHistoryRequest, type ListSubscriptionHistoryResponse, type ListUpcomingChargesOptions, type ListUpcomingChargesRequest, type ListUpcomingChargesResponse, type MarkBillingCycleAsPaidApplicationErrors, type MarkBillingCycleAsPaidOptions, type MarkBillingCycleAsPaidRequest, type MarkBillingCycleAsPaidResponse, type MarkLatestInvoiceAsPaidApplicationErrors, type MarkLatestInvoiceAsPaidRequest, type MarkLatestInvoiceAsPaidResponse, type MessageEnvelope, type MigrationDetails, type Money, type MultipleSubscriptionsOnOrdersInvoice, type OneTime, OrderMethod, type OrderMethodWithLiterals, type Origin, type OriginOverride, type Paging, type PagingMetadataV2, PauseAt, type PauseAtWithLiterals, type PauseInfo, type PausePeriod, PausePolicy, type PausePolicyWithLiterals, type PauseSubscriptionApplicationErrors, type PauseSubscriptionBORequest, type PauseSubscriptionBOResponse, type PauseSubscriptionOptions, type PauseSubscriptionRequest, type PauseSubscriptionRequested, type PauseSubscriptionResponse, type PayCycleOptions, type PayCycleRequest, type PayCycleResponse, type PayRecurringInvoice, PaymentAttemptStatus, type PaymentAttemptStatusWithLiterals, type PaymentData, type PaymentMethod, type PaymentMethodUpdated, PaymentMode, type PaymentModeWithLiterals, type PaymentOrigin, type PaymentSettings, PaymentSettlementMethod, type PaymentSettlementMethodWithLiterals, PaymentStatus, PaymentStatusEnumPaymentStatus, type PaymentStatusEnumPaymentStatusWithLiterals, type PaymentStatusWithLiterals, PaymentTestMode, type PaymentTestModeWithLiterals, type PlatformOrigin, type PreviewSubscriptionChargesOptions, type PreviewSubscriptionChargesOptionsSubscriptionOneOf, type PreviewSubscriptionChargesRequest, type PreviewSubscriptionChargesRequestSubscriptionOneOf, type PreviewSubscriptionChargesResponse, type PreviewSubscriptionsChargesOptions, type PreviewSubscriptionsChargesRequest, type PreviewSubscriptionsChargesResponse, type PriceAdjustment, type PriceAdjustmentAdjustmentTypeOneOf, type PriceAdjustmentValue, type PriceAdjustmentValueAdjustmentValueTypeOneOf, type PriceDetails, type PricingModel, type PricingModelModelOneOf, type Proration, type ProrationTypeOneOf, type QuerySubscriptionsRequest, type QuerySubscriptionsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type Recurring, type RedirectUrls, type Refund, type RefundInfo, RefundReason, type RefundReasonWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, type Reschedule, type ResetPendingUpdates, type RestoreDraftSubscriptionRequest, type RestoreDraftSubscriptionResponse, type RestoreInfo, ResumeAt, type ResumeAtWithLiterals, type ResumeSubscriptionApplicationErrors, type ResumeSubscriptionOptions, type ResumeSubscriptionRequest, type ResumeSubscriptionRequested, type ResumeSubscriptionResponse, type ReviseSubscriptionRequest, type ReviseSubscriptionResponse, RevivePolicy, type RevivePolicyWithLiterals, type ReviveSubscriptionRequest, type ReviveSubscriptionResponse, type RunTimeCapsuleTaskNowRequest, type ScheduleAdditionalInfo, type ScheduleAdditionalInfoParamOneOf, type ScheduleTimeCapsuleTaskRequest, type ScheduledPauseCanceled, type ScheduledResumeCanceled, type SearchSubscriptionRequest, type SearchSubscriptionResponse, type SearchSubscriptionsOptions, type SearchSubscriptionsOptionsPagingMethodOneOf, type SearchSubscriptionsRequest, type SearchSubscriptionsRequestPagingMethodOneOf, type SearchSubscriptionsResponse, type SendSubscriptionActionEventBORequest, type SendSubscriptionActionEventBORequestEventOneOf, type SendSubscriptionActionEventResponse, type SendTimeCapsuleTaskCanceledBIRequest, type SetIsMigratedEvent, type SetShiftingDataRequest, type SetShiftingDataResponse, type ShippingCharges, SortOrder, type SortOrderWithLiterals, type Sorting, type SortingClauses, type SpecificDateSubscriptionUpdateData, Status, type StatusWithLiterals, type StreetAddress, type Subscriber, type Subscription, type SubscriptionActivated, type SubscriptionAutoRenewalTurnedOff, type SubscriptionAutoRenewalTurnedOffEnvelope, type SubscriptionAutoRenewalTurnedOn, type SubscriptionAutoRenewalTurnedOnEnvelope, type SubscriptionBackOfficeAction, type SubscriptionBillingCyclePaid, type SubscriptionBillingCycleStarted, type SubscriptionBillingDateUpdated, type SubscriptionBillingDateUpdatedEnvelope, type SubscriptionBillingDetails, type SubscriptionCanceled, type SubscriptionCanceledEnvelope, type SubscriptionCancellationRequested, type SubscriptionCharge, type SubscriptionCharges, type SubscriptionCollectionMethodUpdated, type SubscriptionCreated, type SubscriptionCycleReadyToPay, type SubscriptionCycleTriggered, type SubscriptionDelayedSyncEvent, type SubscriptionDeleted, type SubscriptionDiff, type SubscriptionEnded, type SubscriptionEvent, type SubscriptionEventPayloadOneOf, type SubscriptionExpired, type SubscriptionExtended, type SubscriptionExtendedEnvelope, type SubscriptionExtendedExtendPolicyOneOf, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionHistoryEntry, type SubscriptionInfo, type SubscriptionInitialPurchaseCompleted, type SubscriptionInvoice, type SubscriptionLatestInvoiceMarkedAsPaidEnvelope, type SubscriptionMarkedAsPaid, type SubscriptionPauseScheduleCanceledEnvelope, type SubscriptionPauseScheduledEnvelope, type SubscriptionPaused, type SubscriptionPausedEnvelope, type SubscriptionPolicies, type SubscriptionPolicy, type SubscriptionResumeScheduleCanceledEnvelope, type SubscriptionResumeScheduledEnvelope, type SubscriptionResumed, type SubscriptionResumedEnvelope, type SubscriptionRevived, type SubscriptionStatus, SubscriptionStatusEnumSubscriptionStatus, type SubscriptionStatusEnumSubscriptionStatusWithLiterals, SubscriptionStatusGroup, type SubscriptionStatusGroupWithLiterals, type SubscriptionSuspended, type SubscriptionTrialPeriod, SubscriptionType, type SubscriptionTypeWithLiterals, type SubscriptionUpdateData, type SubscriptionUpdated, type SubscriptionUpdatedEnvelope, type Suspension, type Task, type TaskAction, type TaskActionActionOneOf, type TaskKey, type Tax, type TaxBreakdown, type TaxData, type TaxSettings, type TaxSummary, type TaxValueOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TimeBasedProration, type Totals, type TurnOffSubscriptionAutoRenewalApplicationErrors, type TurnOffSubscriptionAutoRenewalRequest, type TurnOffSubscriptionAutoRenewalResponse, type TurnOnSubscriptionAutoRenewalApplicationErrors, type TurnOnSubscriptionAutoRenewalRequest, type TurnOnSubscriptionAutoRenewalResponse, type UnknownSubscriptionEvent, type UnsupportedAction, type UnsupportedReason, UpdateAction, type UpdateActionWithLiterals, type UpdateBillingDateData, type UpdateFullSubscriptionRequest, type UpdateFullSubscriptionResponse, type UpdatePausePaidDurationRequest, type UpdatePausePaidDurationResponse, type UpdatePaymentMethodBORequest, type UpdatePaymentMethodBOResponse, type UpdatePaymentStatusRequest, type UpdatePaymentStatusResponse, type UpdateStatusRequest, type UpdateStatusResponse, type UpdateSubscriptionBillingDateApplicationErrors, type UpdateSubscriptionBillingDateOptions, type UpdateSubscriptionBillingDateRequest, type UpdateSubscriptionBillingDateResponse, type UpdateSubscriptionInvoiceCycleRequest, type UpdateSubscriptionInvoiceCycleResponse, type UpdateSubscriptionItemsRequest, type UpdateSubscriptionItemsResponse, type UpdateSubscriptionOriginRequest, type UpdateSubscriptionOriginResponse, type UpdateSubscriptionPaymentMethodRequest, type UpdateSubscriptionPaymentMethodResponse, type UpdateSubscriptionPoliciesRequest, type UpdateSubscriptionPoliciesResponse, type UpdateSubscriptionRequest, type UpdateSubscriptionResponse, type UpdateSubscriptionStartDateRequest, type UpdateSubscriptionStartDateResponse, type UpdatesApplied, type V1Duration, type V1Subscription, type V1SubscriptionActivated, type V1SubscriptionCanceled, type V1SubscriptionCreated, type V1SubscriptionEvent, type V1SubscriptionEventEventOneOf, type V1SubscriptionInitialPurchaseCompleted, type V1SubscriptionResumed, V1SubscriptionStatusEnumSubscriptionStatus, type V1SubscriptionStatusEnumSubscriptionStatusWithLiterals, type V1SubscriptionUpdated, type V2Subscription, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, allowedActions, cancelSubscription, countSubscriptions, customerAllowedActions, customerCancelSubscription, customerExtendSubscription, customerGetSubscription, customerInitiatePaymentMethodSetup, customerListUpcomingCharges, customerQuerySubscriptions, customerTurnOffSubscriptionAutoRenewal, customerTurnOnSubscriptionAutoRenewal, customerUpdateSubscriptionPaymentMethod, extendSubscription, getSubscription, getSubscriptionsStats, initiatePaymentMethodSetup, listSubscriptionHistory, listUpcomingCharges, markBillingCycleAsPaid, markLatestInvoiceAsPaid, onSubscriptionAutoRenewalTurnedOff, onSubscriptionAutoRenewalTurnedOn, onSubscriptionBillingDateUpdated, onSubscriptionCanceled, onSubscriptionExtended, onSubscriptionLatestInvoiceMarkedAsPaid, onSubscriptionPauseScheduleCanceled, onSubscriptionPauseScheduled, onSubscriptionPaused, onSubscriptionResumeScheduleCanceled, onSubscriptionResumeScheduled, onSubscriptionResumed, onSubscriptionUpdated, pauseSubscription, payCycle, previewSubscriptionCharges, previewSubscriptionsCharges, querySubscriptions, resumeSubscription, searchSubscriptions, turnOffSubscriptionAutoRenewal, turnOnSubscriptionAutoRenewal, updateSubscriptionBillingDate, updateSubscriptionPaymentMethod };