@wix/auto_sdk_subscription_subscriptions 1.0.7 → 1.0.8

package/build/internal/cjs/meta.d.ts

@@ -1 +1,2373 @@
-export * from './src/billing-v1-subscription-subscriptions.meta.js';
+import { GetSubscriptionRequest as GetSubscriptionRequest$1, GetSubscriptionResponse as GetSubscriptionResponse$1, CustomerCancelSubscriptionRequest as CustomerCancelSubscriptionRequest$1, CustomerCancelSubscriptionResponse as CustomerCancelSubscriptionResponse$1, CustomerTurnOnAutoRenewalRequest as CustomerTurnOnAutoRenewalRequest$1, CustomerTurnOnAutoRenewalResponse as CustomerTurnOnAutoRenewalResponse$1, CustomerTurnOffAutoRenewalRequest as CustomerTurnOffAutoRenewalRequest$1, CustomerTurnOffAutoRenewalResponse as CustomerTurnOffAutoRenewalResponse$1, CustomerExtendSubscriptionRequest as CustomerExtendSubscriptionRequest$1, CustomerExtendSubscriptionResponse as CustomerExtendSubscriptionResponse$1, QuerySubscriptionsRequest as QuerySubscriptionsRequest$1, QuerySubscriptionsResponse as QuerySubscriptionsResponse$1, UpdateSubscriptionPaymentMethodRequest as UpdateSubscriptionPaymentMethodRequest$1, UpdateSubscriptionPaymentMethodResponse as UpdateSubscriptionPaymentMethodResponse$1, CustomerAllowedActionsRequest as CustomerAllowedActionsRequest$1, CustomerAllowedActionsResponse as CustomerAllowedActionsResponse$1, CustomerListUpcomingChargesRequest as CustomerListUpcomingChargesRequest$1, CustomerListUpcomingChargesResponse as CustomerListUpcomingChargesResponse$1, InitiatePaymentMethodSetupRequest as InitiatePaymentMethodSetupRequest$1, InitiatePaymentMethodSetupResponse as InitiatePaymentMethodSetupResponse$1, PayCycleRequest as PayCycleRequest$1, PayCycleResponse as PayCycleResponse$1, UpdateSubscriptionBillingDateRequest as UpdateSubscriptionBillingDateRequest$1, UpdateSubscriptionBillingDateResponse as UpdateSubscriptionBillingDateResponse$1, CancelSubscriptionRequest as CancelSubscriptionRequest$1, CancelSubscriptionResponse as CancelSubscriptionResponse$1, PauseSubscriptionRequest as PauseSubscriptionRequest$1, PauseSubscriptionResponse as PauseSubscriptionResponse$1, ResumeSubscriptionRequest as ResumeSubscriptionRequest$1, ResumeSubscriptionResponse as ResumeSubscriptionResponse$1, SearchSubscriptionsRequest as SearchSubscriptionsRequest$1, SearchSubscriptionsResponse as SearchSubscriptionsResponse$1, CountSubscriptionsRequest as CountSubscriptionsRequest$1, CountSubscriptionsResponse as CountSubscriptionsResponse$1, TurnOnSubscriptionAutoRenewalRequest as TurnOnSubscriptionAutoRenewalRequest$1, TurnOnSubscriptionAutoRenewalResponse as TurnOnSubscriptionAutoRenewalResponse$1, TurnOffSubscriptionAutoRenewalRequest as TurnOffSubscriptionAutoRenewalRequest$1, TurnOffSubscriptionAutoRenewalResponse as TurnOffSubscriptionAutoRenewalResponse$1, MarkLatestInvoiceAsPaidRequest as MarkLatestInvoiceAsPaidRequest$1, MarkLatestInvoiceAsPaidResponse as MarkLatestInvoiceAsPaidResponse$1, MarkBillingCycleAsPaidRequest as MarkBillingCycleAsPaidRequest$1, MarkBillingCycleAsPaidResponse as MarkBillingCycleAsPaidResponse$1, GetSubscriptionsStatsRequest as GetSubscriptionsStatsRequest$1, GetSubscriptionsStatsResponse as GetSubscriptionsStatsResponse$1, ExtendSubscriptionRequest as ExtendSubscriptionRequest$1, ExtendSubscriptionResponse as ExtendSubscriptionResponse$1, AllowedActionsRequest as AllowedActionsRequest$1, AllowedActionsResponse as AllowedActionsResponse$1, ListUpcomingChargesRequest as ListUpcomingChargesRequest$1, ListUpcomingChargesResponse as ListUpcomingChargesResponse$1, PreviewSubscriptionChargesRequest as PreviewSubscriptionChargesRequest$1, PreviewSubscriptionChargesResponse as PreviewSubscriptionChargesResponse$1, PreviewSubscriptionsChargesRequest as PreviewSubscriptionsChargesRequest$1, PreviewSubscriptionsChargesResponse as PreviewSubscriptionsChargesResponse$1, ListSubscriptionHistoryRequest as ListSubscriptionHistoryRequest$1, ListSubscriptionHistoryResponse as ListSubscriptionHistoryResponse$1 } from './index.typings.js';
+import '@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. */
+    addressLine?: 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 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 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;
+}
+declare enum ActionInitiator {
+    UNDEFINED = "UNDEFINED",
+    BUSINESS = "BUSINESS",
+    CUSTOMER = "CUSTOMER",
+    SYSTEM = "SYSTEM"
+}
+/** @enumType */
+type ActionInitiatorWithLiterals = ActionInitiator | 'UNDEFINED' | 'BUSINESS' | 'CUSTOMER' | 'SYSTEM';
+interface SubscriptionBillingCycleStarted {
+    subscription?: Subscription;
+    /**
+     * Wix Pay transaction id, optional. Exists if event was triggered by a payment.
+     * @format GUID
+     */
+    paymentTransactionId?: string | null;
+}
+/**
+ * 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 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;
+}
+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 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 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 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;
+    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;
+    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 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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function customerGetSubscription(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetSubscriptionRequest$1, GetSubscriptionRequest, GetSubscriptionResponse$1, GetSubscriptionResponse>;
+declare function customerCancelSubscription(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, CustomerCancelSubscriptionRequest$1, CustomerCancelSubscriptionRequest, CustomerCancelSubscriptionResponse$1, CustomerCancelSubscriptionResponse>;
+declare function customerTurnOnSubscriptionAutoRenewal(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, CustomerTurnOnAutoRenewalRequest$1, CustomerTurnOnAutoRenewalRequest, CustomerTurnOnAutoRenewalResponse$1, CustomerTurnOnAutoRenewalResponse>;
+declare function customerTurnOffSubscriptionAutoRenewal(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, CustomerTurnOffAutoRenewalRequest$1, CustomerTurnOffAutoRenewalRequest, CustomerTurnOffAutoRenewalResponse$1, CustomerTurnOffAutoRenewalResponse>;
+declare function customerExtendSubscription(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, CustomerExtendSubscriptionRequest$1, CustomerExtendSubscriptionRequest, CustomerExtendSubscriptionResponse$1, CustomerExtendSubscriptionResponse>;
+declare function customerQuerySubscriptions(): __PublicMethodMetaInfo<'POST', {}, QuerySubscriptionsRequest$1, QuerySubscriptionsRequest, QuerySubscriptionsResponse$1, QuerySubscriptionsResponse>;
+declare function customerUpdateSubscriptionPaymentMethod(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, UpdateSubscriptionPaymentMethodRequest$1, UpdateSubscriptionPaymentMethodRequest, UpdateSubscriptionPaymentMethodResponse$1, UpdateSubscriptionPaymentMethodResponse>;
+declare function customerAllowedActions(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, CustomerAllowedActionsRequest$1, CustomerAllowedActionsRequest, CustomerAllowedActionsResponse$1, CustomerAllowedActionsResponse>;
+declare function customerListUpcomingCharges(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, CustomerListUpcomingChargesRequest$1, CustomerListUpcomingChargesRequest, CustomerListUpcomingChargesResponse$1, CustomerListUpcomingChargesResponse>;
+declare function customerInitiatePaymentMethodSetup(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, InitiatePaymentMethodSetupRequest$1, InitiatePaymentMethodSetupRequest, InitiatePaymentMethodSetupResponse$1, InitiatePaymentMethodSetupResponse>;
+declare function payCycle(): __PublicMethodMetaInfo<'POST', {
+    subscriptionId: string;
+}, PayCycleRequest$1, PayCycleRequest, PayCycleResponse$1, PayCycleResponse>;
+declare function getSubscription(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetSubscriptionRequest$1, GetSubscriptionRequest, GetSubscriptionResponse$1, GetSubscriptionResponse>;
+declare function updateSubscriptionPaymentMethod(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, UpdateSubscriptionPaymentMethodRequest$1, UpdateSubscriptionPaymentMethodRequest, UpdateSubscriptionPaymentMethodResponse$1, UpdateSubscriptionPaymentMethodResponse>;
+declare function updateSubscriptionBillingDate(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, UpdateSubscriptionBillingDateRequest$1, UpdateSubscriptionBillingDateRequest, UpdateSubscriptionBillingDateResponse$1, UpdateSubscriptionBillingDateResponse>;
+declare function cancelSubscription(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, CancelSubscriptionRequest$1, CancelSubscriptionRequest, CancelSubscriptionResponse$1, CancelSubscriptionResponse>;
+declare function pauseSubscription(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, PauseSubscriptionRequest$1, PauseSubscriptionRequest, PauseSubscriptionResponse$1, PauseSubscriptionResponse>;
+declare function resumeSubscription(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, ResumeSubscriptionRequest$1, ResumeSubscriptionRequest, ResumeSubscriptionResponse$1, ResumeSubscriptionResponse>;
+declare function querySubscriptions(): __PublicMethodMetaInfo<'POST', {}, QuerySubscriptionsRequest$1, QuerySubscriptionsRequest, QuerySubscriptionsResponse$1, QuerySubscriptionsResponse>;
+declare function searchSubscriptions(): __PublicMethodMetaInfo<'POST', {}, SearchSubscriptionsRequest$1, SearchSubscriptionsRequest, SearchSubscriptionsResponse$1, SearchSubscriptionsResponse>;
+declare function countSubscriptions(): __PublicMethodMetaInfo<'POST', {}, CountSubscriptionsRequest$1, CountSubscriptionsRequest, CountSubscriptionsResponse$1, CountSubscriptionsResponse>;
+declare function turnOnSubscriptionAutoRenewal(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, TurnOnSubscriptionAutoRenewalRequest$1, TurnOnSubscriptionAutoRenewalRequest, TurnOnSubscriptionAutoRenewalResponse$1, TurnOnSubscriptionAutoRenewalResponse>;
+declare function turnOffSubscriptionAutoRenewal(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, TurnOffSubscriptionAutoRenewalRequest$1, TurnOffSubscriptionAutoRenewalRequest, TurnOffSubscriptionAutoRenewalResponse$1, TurnOffSubscriptionAutoRenewalResponse>;
+declare function markLatestInvoiceAsPaid(): __PublicMethodMetaInfo<'POST', {
+    subscriptionId: string;
+}, MarkLatestInvoiceAsPaidRequest$1, MarkLatestInvoiceAsPaidRequest, MarkLatestInvoiceAsPaidResponse$1, MarkLatestInvoiceAsPaidResponse>;
+declare function markBillingCycleAsPaid(): __PublicMethodMetaInfo<'POST', {
+    subscriptionId: string;
+}, MarkBillingCycleAsPaidRequest$1, MarkBillingCycleAsPaidRequest, MarkBillingCycleAsPaidResponse$1, MarkBillingCycleAsPaidResponse>;
+declare function getSubscriptionsStats(): __PublicMethodMetaInfo<'GET', {}, GetSubscriptionsStatsRequest$1, GetSubscriptionsStatsRequest, GetSubscriptionsStatsResponse$1, GetSubscriptionsStatsResponse>;
+declare function extendSubscription(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, ExtendSubscriptionRequest$1, ExtendSubscriptionRequest, ExtendSubscriptionResponse$1, ExtendSubscriptionResponse>;
+declare function allowedActions(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, AllowedActionsRequest$1, AllowedActionsRequest, AllowedActionsResponse$1, AllowedActionsResponse>;
+declare function listUpcomingCharges(): __PublicMethodMetaInfo<'GET', {
+    subscriptionId: string;
+}, ListUpcomingChargesRequest$1, ListUpcomingChargesRequest, ListUpcomingChargesResponse$1, ListUpcomingChargesResponse>;
+declare function previewSubscriptionCharges(): __PublicMethodMetaInfo<'GET', {}, PreviewSubscriptionChargesRequest$1, PreviewSubscriptionChargesRequest, PreviewSubscriptionChargesResponse$1, PreviewSubscriptionChargesResponse>;
+declare function previewSubscriptionsCharges(): __PublicMethodMetaInfo<'GET', {}, PreviewSubscriptionsChargesRequest$1, PreviewSubscriptionsChargesRequest, PreviewSubscriptionsChargesResponse$1, PreviewSubscriptionsChargesResponse>;
+declare function initiatePaymentMethodSetup(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, InitiatePaymentMethodSetupRequest$1, InitiatePaymentMethodSetupRequest, InitiatePaymentMethodSetupResponse$1, InitiatePaymentMethodSetupResponse>;
+declare function listSubscriptionHistory(): __PublicMethodMetaInfo<'GET', {
+    subscriptionId: string;
+}, ListSubscriptionHistoryRequest$1, ListSubscriptionHistoryRequest, ListSubscriptionHistoryResponse$1, ListSubscriptionHistoryResponse>;
+
+export { type __PublicMethodMetaInfo, allowedActions, cancelSubscription, countSubscriptions, customerAllowedActions, customerCancelSubscription, customerExtendSubscription, customerGetSubscription, customerInitiatePaymentMethodSetup, customerListUpcomingCharges, customerQuerySubscriptions, customerTurnOffSubscriptionAutoRenewal, customerTurnOnSubscriptionAutoRenewal, customerUpdateSubscriptionPaymentMethod, extendSubscription, getSubscription, getSubscriptionsStats, initiatePaymentMethodSetup, listSubscriptionHistory, listUpcomingCharges, markBillingCycleAsPaid, markLatestInvoiceAsPaid, pauseSubscription, payCycle, previewSubscriptionCharges, previewSubscriptionsCharges, querySubscriptions, resumeSubscription, searchSubscriptions, turnOffSubscriptionAutoRenewal, turnOnSubscriptionAutoRenewal, updateSubscriptionBillingDate, updateSubscriptionPaymentMethod };