@wix/auto_sdk_ecom_cart 1.0.181 → 1.0.183

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

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { CreateCartOptions, Cart, CreateCartApplicationErrors, UpdateCartOptions, UpdateCartApplicationErrors, GetCartByCheckoutIdResponse, AddToCartOptions, AddToCartResponse, AddToCartApplicationErrors, RemoveLineItemsResponse, CreateCheckoutOptions, CreateCheckoutResponse, CreateCheckoutApplicationErrors, RemoveCouponResponse, LineItemQuantityUpdate, UpdateLineItemsQuantityResponse, EstimateTotalsOptions, EstimateTotalsResponse, RemoveBusinessLocationResponse, CartDeletedEnvelope, CartUpdatedEnvelope, CartCreatedEnvelope } from './index.typings.js';
-export { AccountInfo, AccountInfoMetadata, ActionEvent, AddToCartRequest, AddToCurrentCartAndEstimateTotalsRequest, AddToCurrentCartRequest, AdditionalFee, AdditionalFeeSource, AdditionalFeeSourceWithLiterals, Address, AddressLocation, AddressWithContact, AggregatedTaxBreakdown, ApplicableLineItems, ApplicationError, AppliedDiscount, AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, AppliedDiscountDiscountTypeWithLiterals, AutoTaxFallbackCalculationDetails, BalanceType, BalanceTypeWithLiterals, BaseEventMetadata, Benefit, BenefitQuotaOneOf, BillingSettings, BuyerInfo, BuyerInfoIdOneOf, CalculatedItemModifier, CalculatedLineItem, CalculationErrors, CalculationErrorsShippingCalculationErrorOneOf, Carrier, CarrierError, CarrierErrors, CarrierServiceOption, CartDiscount, CartDiscountDiscountSourceOneOf, CatalogOverrideFields, CatalogReference, ChannelType, ChannelTypeWithLiterals, ChargeType, ChargeTypeWithLiterals, Color, Coupon, CoveredLineItem, CreateCartRequest, CreateCartResponse, CreateCheckoutFromCurrentCartRequest, CreateCheckoutRequest, CustomLineItem, DeleteCartRequest, DeleteCartResponse, DeleteCurrentCartRequest, DeliveryAllocation, DeliveryLogistics, DeliveryTimeSlot, Description, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineTypeWithLiterals, DescriptionLineValueOneOf, Details, DetailsKindOneOf, Dimensions, DimensionsUnit, DimensionsUnitWithLiterals, DiscountRule, DiscountRuleName, DiscountType, DiscountTypeWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EstimateCurrentCartTotalsRequest, EstimateTotalsRequest, EventMetadata, ExistingMembership, ExtendedFields, FallbackReason, FallbackReasonWithLiterals, FieldViolation, FileType, FileTypeWithLiterals, FocalPoint, FreeTrialPeriod, FullAddressContactDetails, GetCartByCheckoutIdRequest, GetCartRequest, GetCartResponse, GetCurrentCartRequest, GetCurrentCartResponse, GiftCard, GiftCardCalculationError, Group, HostSelectedMembership, IdentificationData, IdentificationDataIdOneOf, InvalidMembership, ItemAvailabilityInfo, ItemAvailabilityStatus, ItemAvailabilityStatusWithLiterals, ItemCombination, ItemCombinationLineItem, ItemModifier, ItemTaxFullDetails, ItemType, ItemTypeItemTypeDataOneOf, ItemTypePreset, ItemTypePresetWithLiterals, JurisdictionType, JurisdictionTypeWithLiterals, LimitedQuota, LimitedQuotaType, LimitedQuotaTypeWithLiterals, LineItem, LineItemAdded, LineItemCoverage, LineItemDiscount, LineItemPricesData, ManualCalculationReason, ManualCalculationReasonWithLiterals, Membership, MembershipName, MembershipOptions, MembershipPaymentCredits, MerchantDiscount, MessageEnvelope, ModifierGroup, MultiCurrencyPrice, NameInLineItem, NameInLineItemWithLiterals, NameInOther, NameInOtherWithLiterals, Other, OtherCharge, PaymentOption, PaymentOptionType, PaymentOptionTypeWithLiterals, PhysicalProperties, PickupDetails, PickupMethod, PickupMethodWithLiterals, PlainTextValue, PlatformFee, PlatformFeeChargeType, PlatformFeeChargeTypeWithLiterals, Policy, PriceDescription, PriceSummary, ProductName, ProductPeriodAlignment, ProductPeriodAlignmentWithLiterals, PurchasablePlan, QuotaType, QuotaTypeWithLiterals, RateType, RateTypeWithLiterals, Region, RemoveBusinessLocationRequest, RemoveCouponFromCurrentCartRequest, RemoveCouponRequest, RemoveLineItemsFromCurrentCartRequest, RemoveLineItemsRequest, RestoreInfo, RuleType, RuleTypeWithLiterals, Scope, SecuredMedia, SelectedCarrierServiceOption, SelectedCarrierServiceOptionOtherCharge, SelectedCarrierServiceOptionPrices, SelectedMembership, SelectedMemberships, SelectedShippingOption, ServiceProperties, Severity, SeverityWithLiterals, ShippingInformation, ShippingOption, ShippingPrice, ShippingRegion, StreetAddress, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, SubscriptionOptionInfo, SubscriptionSettings, SuggestedFix, SuggestedFixWithLiterals, SystemError, Target, TargetLineItem, TargetTargetTypeOneOf, TaxBreakdown, TaxCalculationDetails, TaxCalculationDetailsCalculationDetailsOneOf, TaxRateBreakdown, TaxSummary, TaxableAddress, TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, TaxableAddressTypeWithLiterals, Title, TranslatableString, UpdateCartRequest, UpdateCartResponse, UpdateCurrentCartLineItemQuantityRequest, UpdateLineItemsQuantityRequest, V1Coupon, V1DiscountRule, V1DiscountRuleName, V1ItemModifier, V1Membership, V1MerchantDiscount, V1ModifierGroup, ValidatedExistingMemberships, ValidatedPurchasablePlans, ValidationError, VatId, VatType, VatTypeWithLiterals, Violation, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeightUnit, WeightUnitWithLiterals } from './index.typings.js';
+export { AccountInfo, AccountInfoMetadata, ActionEvent, AddToCartRequest, AddToCurrentCartAndEstimateTotalsRequest, AddToCurrentCartRequest, AdditionalFee, AdditionalFeeSource, AdditionalFeeSourceWithLiterals, Address, AddressLocation, AddressWithContact, AggregatedTaxBreakdown, ApplicableLineItems, ApplicationError, AppliedDiscount, AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, AppliedDiscountDiscountTypeWithLiterals, AutoTaxFallbackCalculationDetails, BalanceType, BalanceTypeWithLiterals, BaseEventMetadata, Benefit, BenefitQuotaOneOf, BillingSettings, BuyerInfo, BuyerInfoIdOneOf, CalculatedItemModifier, CalculatedLineItem, CalculationErrors, CalculationErrorsShippingCalculationErrorOneOf, Carrier, CarrierError, CarrierErrors, CarrierServiceOption, CartDiscount, CartDiscountDiscountSourceOneOf, CatalogOverrideFields, CatalogReference, ChannelType, ChannelTypeWithLiterals, ChargeType, ChargeTypeWithLiterals, Color, Coupon, CoveredLineItem, CreateCartRequest, CreateCartResponse, CreateCheckoutFromCurrentCartRequest, CreateCheckoutRequest, CustomLineItem, CyclePriceOverride, DeleteCartRequest, DeleteCartResponse, DeleteCurrentCartRequest, DeliveryAllocation, DeliveryLogistics, DeliveryTimeSlot, Description, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineTypeWithLiterals, DescriptionLineValueOneOf, Details, DetailsKindOneOf, Dimensions, DimensionsUnit, DimensionsUnitWithLiterals, DiscountRule, DiscountRuleName, DiscountType, DiscountTypeWithLiterals, DomainEvent, DomainEventBodyOneOf, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EstimateCurrentCartTotalsRequest, EstimateTotalsRequest, EventMetadata, ExistingMembership, ExtendedFields, FallbackReason, FallbackReasonWithLiterals, FieldViolation, FileType, FileTypeWithLiterals, FocalPoint, FreeTrialPeriod, FullAddressContactDetails, GetCartByCheckoutIdRequest, GetCartRequest, GetCartResponse, GetCurrentCartRequest, GetCurrentCartResponse, GiftCard, GiftCardCalculationError, Group, HostSelectedMembership, IdentificationData, IdentificationDataIdOneOf, InvalidMembership, ItemAvailabilityInfo, ItemAvailabilityStatus, ItemAvailabilityStatusWithLiterals, ItemCombination, ItemCombinationLineItem, ItemModifier, ItemTaxFullDetails, ItemType, ItemTypeItemTypeDataOneOf, ItemTypePreset, ItemTypePresetWithLiterals, JurisdictionType, JurisdictionTypeWithLiterals, LimitedQuota, LimitedQuotaType, LimitedQuotaTypeWithLiterals, LineItem, LineItemAdded, LineItemCoverage, LineItemDiscount, LineItemPricesData, ManualCalculationReason, ManualCalculationReasonWithLiterals, Membership, MembershipName, MembershipOptions, MembershipPaymentCredits, MerchantDiscount, MessageEnvelope, ModifierGroup, MultiCurrencyPrice, NameInLineItem, NameInLineItemWithLiterals, NameInOther, NameInOtherWithLiterals, Other, OtherCharge, PaymentOption, PaymentOptionType, PaymentOptionTypeWithLiterals, PhysicalProperties, PickupDetails, PickupMethod, PickupMethodWithLiterals, PlainTextValue, PlatformFee, PlatformFeeChargeType, PlatformFeeChargeTypeWithLiterals, Policy, PriceDescription, PriceSummary, ProductName, ProductPeriodAlignment, ProductPeriodAlignmentWithLiterals, PurchasablePlan, QuotaType, QuotaTypeWithLiterals, RateType, RateTypeWithLiterals, Region, RemoveBusinessLocationRequest, RemoveCouponFromCurrentCartRequest, RemoveCouponRequest, RemoveLineItemsFromCurrentCartRequest, RemoveLineItemsRequest, RestoreInfo, RuleType, RuleTypeWithLiterals, Scope, SecuredMedia, SelectedCarrierServiceOption, SelectedCarrierServiceOptionOtherCharge, SelectedCarrierServiceOptionPrices, SelectedMembership, SelectedMemberships, SelectedShippingOption, ServiceProperties, Severity, SeverityWithLiterals, ShippingInformation, ShippingOption, ShippingPrice, ShippingRegion, StreetAddress, SubscriptionFrequency, SubscriptionFrequencyWithLiterals, SubscriptionOptionInfo, SubscriptionSettings, SuggestedFix, SuggestedFixWithLiterals, SystemError, Target, TargetLineItem, TargetTargetTypeOneOf, TaxBreakdown, TaxCalculationDetails, TaxCalculationDetailsCalculationDetailsOneOf, TaxRateBreakdown, TaxSummary, TaxableAddress, TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, TaxableAddressTypeWithLiterals, Title, TranslatableString, UpdateCartRequest, UpdateCartResponse, UpdateCurrentCartLineItemQuantityRequest, UpdateLineItemsQuantityRequest, V1Coupon, V1DiscountRule, V1DiscountRuleName, V1ItemModifier, V1Membership, V1MerchantDiscount, V1ModifierGroup, ValidatedExistingMemberships, ValidatedPurchasablePlans, ValidationError, VatId, VatType, VatTypeWithLiterals, Violation, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WeightUnit, WeightUnitWithLiterals } from './index.typings.js';
 
 declare function createCart$1(httpClient: HttpClient): CreateCartSignature;
 interface CreateCartSignature {

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

@@ -709,7 +709,7 @@ interface SubscriptionSettings {
      * @min 1
      */
     billingCycles?: number | null;
-    /** Whether to allow the customer to cancel the subscription.. */
+    /** Whether to allow the customer to cancel the subscription. */
     enableCustomerCancellation?: boolean;
     /**
      * Period until first cycle starts. If applied payNow will be 0
@@ -731,6 +731,15 @@ interface SubscriptionSettings {
      * @internal
      */
     productPeriodAlignment?: ProductPeriodAlignmentWithLiterals;
+    /**
+     * Unit prices for specified billing cycles of the subscription. Cycles that no entry covers
+     * are charged the item's `price`.
+     *
+     * When `billingCycles` is set, every entry must end on or before the last billing cycle.
+     * @internal
+     * @maxSize 1
+     */
+    cyclePriceOverrides?: CyclePriceOverride[];
 }
 /** Frequency unit of recurring payment */
 declare enum SubscriptionFrequency {
@@ -768,6 +777,27 @@ declare enum ProductPeriodAlignment {
 }
 /** @enumType */
 type ProductPeriodAlignmentWithLiterals = ProductPeriodAlignment | 'ALIGNED_WITH_BILLING_PERIOD' | 'NOT_ALIGNED_WITH_BILLING_PERIOD';
+interface CyclePriceOverride {
+    /**
+     * __Required.__ First billing cycle the price applies to. The first paid cycle of the
+     * subscription is `1`. A free trial period, if any, is cycle `0`.
+     * @min 1
+     * @max 1
+     */
+    cycleFrom?: number;
+    /**
+     * __Required.__ Number of consecutive billing cycles the price applies to, starting at `cycleFrom`.
+     * @min 1
+     * @max 1
+     */
+    numberOfCycles?: number | null;
+    /**
+     * __Required.__ Unit price for the cycles this entry covers, in the item's currency.
+     * Can be higher than, lower than, or equal to the item's `price`.
+     * @decimalValue options { gte:0, lte:1000000000000000, maxScale:4 }
+     */
+    price?: string;
+}
 interface Title {
     /**
      * Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
@@ -2815,27 +2845,29 @@ interface Membership {
 }
 interface MembershipName {
     /**
-     * Membership name.
+     * Membership name in the site's original language.
      * @maxLength 100
      */
     original?: string;
     /**
-     * Translated membership name. Defaults to `original` when not provided.
+     * Membership name translated into the buyer's language.
+     *
+     * Default: The value of `original`
      * @maxLength 100
      */
     translated?: string | null;
 }
 interface MembershipPaymentCredits {
     /**
-     * Membership's initial value.
+     * Membership's initial balance.
      * @min 1
      */
     total?: number;
-    /** Membership's remaining value. */
+    /** Membership's remaining balance. */
     remaining?: number;
     /**
-     * Deprecated. The new flow no longer exposes a per-item redemption cost on a membership's credits;
-     * what a membership can pay for is conveyed by `ExistingMembership.covered_line_items` (per-item redemption cost).
+     * Deprecated. Use `ExistingMembership.coveredLineItems`, which carries the redemption cost per line
+     * item. A membership's balance no longer states a per-item cost of its own.
      * @internal
      * @deprecated
      * @replacedBy ExistingMembership.covered_line_items.redemption_cost
@@ -2843,15 +2875,19 @@ interface MembershipPaymentCredits {
      */
     redemptionCost?: number;
     /**
-     * Membership's balance type.
+     * How the membership's balance is measured.
+     *
+     * The same vocabulary as `LimitedQuota.limitedQuotaType` on the purchasable-plan side. The two are
+     * separate types only because this one serves the legacy flow and is left untouched until List
+     * Eligible Memberships is removed.
      * @internal
      */
     balanceType?: BalanceTypeWithLiterals;
 }
 declare enum BalanceType {
-    /** Balance is measured in discrete uses (e.g., sessions, visits). */
+    /** Balance is measured in discrete uses, such as sessions or visits. */
     PUNCH_CARD = "PUNCH_CARD",
-    /** Balance is measured in a currency-like value (e.g., points). */
+    /** Balance is measured in a currency-like value, such as points. */
     CREDIT = "CREDIT"
 }
 /** @enumType */
@@ -2866,25 +2902,26 @@ interface InvalidMembership {
      */
     reason?: string;
 }
-/** Same shape as `ListExistingMembershipsResponse.memberships`. */
+/** The validated existing memberships. Same shape as `ListExistingMembershipsResponse.memberships`. */
 interface ValidatedExistingMemberships {
     /**
-     * The selected memberships, each paired with the line items it can redeem and the cost to redeem each.
+     * The selected memberships, each paired with the line items it can pay for and the cost to redeem
+     * each.
      * @maxSize 300
      */
     memberships?: ExistingMembership[];
 }
 /**
- * A membership the member already owns, together with the input line items it can pay for.
+ * A membership the member owns, together with the given line items it can pay for.
  *
- * A membership is a single benefit granted by a plan the member has already paid for, so coverage is
- * nested here per membership (no `benefit_id` linkage is needed, unlike a plan that grants many benefits).
+ * A membership is a single benefit granted by a plan the member has already paid for, so its coverage
+ * is nested directly here. No `benefitId` link is needed, unlike a plan that grants several benefits.
  */
 interface ExistingMembership {
     /** The membership the member owns. */
     membership?: V1Membership;
     /**
-     * The input line items this membership can pay for, and the cost to redeem each.
+     * Line items this membership can pay for, and the cost to redeem each.
      * @maxSize 300
      */
     coveredLineItems?: CoveredLineItem[];
@@ -2899,11 +2936,10 @@ interface V1Membership {
     /** Membership name. */
     name?: MembershipName;
     /**
-     * Deprecated. Use `ExistingMembership.covered_line_items` to see which line items this membership covers.
+     * Deprecated. Use `ExistingMembership.coveredLineItems` to see which line items this membership
+     * covers.
      *
-     * Populate this only in the legacy `ListEligibleMemberships` flow, which still requires it and rejects a
-     * membership that omits it. Leave it empty everywhere else - `ListMembershipsByIds` receives no line items
-     * at all, so there is nothing to report there.
+     * Populate this only in the legacy [List Eligible Memberships](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-eligible-memberships) flow, which still requires it and rejects a membership that omits it. Leave it empty everywhere else. [List Memberships By IDs](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-memberships-by-ids) receives no line items at all, so there's nothing to report there.
      * @maxSize 300
      * @minLength 1
      * @maxLength 100
@@ -2912,19 +2948,25 @@ interface V1Membership {
      * @targetRemovalDate 2026-08-30
      */
     lineItemIds?: string[];
-    /** Membership's payment credits (balance information). */
+    /**
+     * Membership's balance.
+     *
+     * Omit this field for an unlimited membership, which has no balance to draw down. Every
+     * `ExistingMembership.coveredLineItems.redemptionCost` is then `0`. Unlike a plan's benefit, a
+     * membership carries no explicit unlimited marker: the absence of a balance is the marker.
+     */
     credits?: MembershipPaymentCredits;
-    /** Membership expiration date. */
+    /** Date and time the membership expires. */
     expirationDate?: Date | null;
     /**
-     * Deprecated. Use `offering_description` for human-readable provider data.
+     * Deprecated. Use `offeringDescription` for human-readable data about the offering.
      * @deprecated
      * @replacedBy offering_description
      * @targetRemovalDate 2026-08-30
      */
     additionalData?: Record<string, any> | null;
     /**
-     * Human-readable offering summary for display (for example price and validity text). Provider-supplied.
+     * Human-readable summary of the offering, for display. For example, its price and validity text.
      * @internal
      * @maxLength 500
      */
@@ -2933,18 +2975,21 @@ interface V1Membership {
 /** A line item a membership can pay for, and the cost to redeem it. */
 interface CoveredLineItem {
     /**
-     * The input line item this membership can cover.
+     * ID of the line item this membership can pay for. Matches the `id` of one of the given line items.
      * @minLength 1
      * @maxLength 100
      */
     lineItemId?: string;
     /**
-     * The amount to redeem from the membership's benefit quota (`benefit.limited_quota.remaining`) for this item.
-     * Always 0 when the benefit is unlimited (nothing is decremented).
+     * Amount deducted from the membership's remaining balance (`credits.remaining`) when this line item
+     * is redeemed.
+     *
+     * Always `0` for an unlimited membership, which is expressed by omitting `credits` and decrements
+     * nothing.
      */
     redemptionCost?: number;
 }
-/** Same shape as `ListPurchasablePlansResponse`. */
+/** The validated purchasable plans. Same shape as `ListPurchasablePlansResponse`. */
 interface ValidatedPurchasablePlans {
     /**
      * The selected plans.
@@ -2952,68 +2997,109 @@ interface ValidatedPurchasablePlans {
      */
     purchasablePlans?: PurchasablePlan[];
     /**
-     * How the plans' benefits cover the line items, linked to a benefit by `benefit_id`.
+     * How the plans' benefits cover the line items, each entry naming its benefit by `benefitId`.
      * @maxSize 300
      */
     coverages?: LineItemCoverage[];
 }
 interface PurchasablePlan {
-    /** Catalog and item reference for the plan that can be purchased. */
+    /**
+     * Catalog and item reference identifying both the plan and the pricing variant.
+     *
+     * A purchasable plan has no ID of its own. The reference carries the plan in `catalogItemId` and
+     * the chosen pricing variant in `options`, so the same plan appears once per variant with a
+     * different reference each time. The plan ID alone repeats across entries; the full reference
+     * doesn't.
+     *
+     * When the plan needs nothing further from the buyer, the reference can be added to the cart as it
+     * stands. When it does, for example a plan carrying a form, a custom start date, or a buyer-chosen
+     * price, the reference has to be completed with that input first. See `infoCollectionUrl`.
+     */
     catalogReference?: CatalogReference;
     /** Plan name. */
     name?: MembershipName;
     /**
-     * Benefits the plan would grant once purchased. Multiple entries support multi-benefit plans (e.g., a bundle granting separate yoga and pilates credits).
+     * Benefits the plan grants once purchased.
+     *
+     * A plan can grant several, for example a bundle granting separate yoga and pilates credits. Each
+     * benefit becomes its own membership after purchase.
      * @minSize 1
      * @maxSize 50
      */
     benefits?: Benefit[];
     /**
-     * Human-readable offering summary for display (for example price and validity text). Provider-supplied.
+     * Human-readable summary of what the plan offers, for display. For example, `8 yoga classes and 4
+     * pilates classes, billed monthly`.
+     *
+     * Describe the offering here and the price in `priceDescription`.
      * @maxLength 500
      */
     offeringDescription?: string | null;
     /**
-     * URL the buyer is redirected to in order to collect additional info required to purchase this plan.
+     * URL of the page that collects the extra input this plan needs before it can be purchased.
+     *
+     * Return it only for a plan that needs more from the buyer, such as one carrying a form, a custom
+     * start date, or a buyer-chosen price. Omitting it means the plan needs nothing further, and the
+     * caller builds the cart itself.
+     *
+     * The buyer reaches this page before any cart exists, rather than from the checkout page, and
+     * there's no return trip. The page receives the caller's already-created items, then builds the
+     * cart and checkout from the plan plus those items. There's no return URL, no cart ID, no
+     * preserved selection, and no completion signal: the purchase reaches Wix through the ordinary
+     * checkout and order flow, and the membership through Membership Ready To Be Charged.
+     *
+     * The page covers a single plan. Items that plan covers can be mixed with directly-paid ones, but
+     * a selection spanning two plans isn't supported here.
      * @format WEB_URL
      */
     infoCollectionUrl?: string | null;
     /**
-     * Plan price.
+     * Plan price, in the plan's own configured currency.
+     *
+     * No currency accompanies the amount and none is converted, so prices from different plans aren't
+     * comparable and the currency reaches the buyer only through `priceDescription`. Name the currency
+     * there.
      * @decimalValue options { gte:0, maxScale:3 }
      */
     price?: string;
     /**
-     * Human-readable description of the plan price (for example "First month free, then $20/month").
+     * Human-readable summary of the plan price, for display. For example, `First month free, then
+     * $20/month`.
      *
-     * `price` is simply the price (useful for sorting or comparison, for example), while this is a
-     * descriptive, display-oriented summary of it.
+     * Use `price` for the bare amount, which is what sorting and comparison rely on, and this field for
+     * pricing a buyer needs prose to understand.
      * @maxLength 500
      */
     priceDescription?: string | null;
 }
 /**
- * A single redeemable benefit. A purchasable plan grants one or more benefits (`PurchasablePlan.benefits`);
- * once the plan is paid, each benefit becomes its own membership (charged via `membership_id`).
+ * A single redeemable benefit granted by a plan.
+ *
+ * A purchasable plan grants one or more benefits in `benefits`. Once the plan is paid for, each benefit
+ * becomes its own membership, charged by `membershipId`.
  */
 interface Benefit extends BenefitQuotaOneOf {
     limitedQuota?: LimitedQuota;
     /**
-     * Identifier for this benefit. On a `PurchasablePlan` it must be unique within the response so
-     * `coverages` (`LineItemCoverage.benefit_id`) can reference it unambiguously across the plan's benefits.
+     * Identifier for this benefit, unique within its plan.
+     *
+     * Not unique across the response. A plan is returned once per pricing variant, and every variant
+     * repeats that plan's benefit IDs. Two different plans can also share an ID when they grant the
+     * same benefit, and a coverage entry naming it is then true for both.
+     *
+     * Never give two different benefits the same ID. That's the one case a caller can't recover from,
+     * because a cost computed for one benefit would be applied to the other.
      * @minLength 1
      * @maxLength 200
      */
     benefitId?: string;
     /**
-     * Human-readable label for this benefit (for example, "Manicure" or "Pedicure" on multi-set punchcards).
+     * Human-readable label for this benefit. For example, `Manicure` or `Pedicure` on a multi-set
+     * punch card.
      * @maxLength 200
      */
     label?: string | null;
-    /**
-     * The kind of quota this benefit grants: a countable amount drawn down on redemption (`LIMITED`),
-     * or an unbounded amount that is never drawn down (`UNLIMITED`).
-     */
+    /** Kind of quota this benefit grants. */
     quotaType?: QuotaTypeWithLiterals;
 }
 /** @oneof */
@@ -3021,9 +3107,9 @@ interface BenefitQuotaOneOf {
     limitedQuota?: LimitedQuota;
 }
 declare enum QuotaType {
-    /** The benefit grants a countable quota that is drawn down on redemption. */
+    /** The benefit grants a countable quota that's drawn down on redemption. */
     LIMITED = "LIMITED",
-    /** The benefit is unlimited (unbounded) and is never drawn down. */
+    /** The benefit is unlimited and is never drawn down. */
     UNLIMITED = "UNLIMITED"
 }
 /** @enumType */
@@ -3031,45 +3117,64 @@ type QuotaTypeWithLiterals = QuotaType | 'LIMITED' | 'UNLIMITED';
 /** A limited, countable redeemable amount. */
 interface LimitedQuota {
     /**
-     * The quota's initial value.
+     * Quota's initial value.
      * @min 1
      */
     total?: number;
-    /** The quota's remaining value. */
+    /** Quota's remaining value. */
     remaining?: number;
-    /** How the quota is measured. */
+    /**
+     * How the quota is measured.
+     *
+     * The same vocabulary as `MembershipPaymentCredits.balanceType` on the existing-membership side.
+     */
     limitedQuotaType?: LimitedQuotaTypeWithLiterals;
 }
 declare enum LimitedQuotaType {
-    /** Quota is measured in discrete uses (e.g., sessions, visits). */
+    /** Quota is measured in discrete uses, such as sessions or visits. */
     PUNCH_CARD = "PUNCH_CARD",
-    /** Quota is measured in a currency-like value (e.g., points). */
+    /** Quota is measured in a currency-like value, such as points. */
     CREDIT = "CREDIT"
 }
 /** @enumType */
 type LimitedQuotaTypeWithLiterals = LimitedQuotaType | 'PUNCH_CARD' | 'CREDIT';
 /**
- * Maps a benefit to a line item it can cover, and at what cost, linked to a benefit by `benefit_id`.
- * One entry per (benefit, line item). Returned by `ListPurchasablePlans` (alongside `purchasable_plans`).
- * For the existing-memberships flow the equivalent mapping is `ExistingMembership.covered_line_items`,
- * which needs no `benefit_id` because a membership is a single benefit.
+ * Maps one of a plan's benefits to a line item it can cover, and at what cost.
+ *
+ * One entry per benefit and line item pair, returned by [List Purchasable Plans](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/memberships/memberships-service-plugin/list-purchasable-plans) alongside `purchasablePlans`.
+ *
+ * An entry names a benefit and carries no plan identity, so match its `benefitId` against the
+ * `benefits` of the returned plans and apply it to every entry that grants that benefit. Entries for
+ * the same plan repeat it once per pricing variant, and two different plans sharing a benefit ID
+ * grant the same benefit, so the entry holds for each of them. A caller that stops at the first
+ * match shows nothing incorrect, but hides the other entries, which cover the item too.
+ *
+ * The cost is identical across a plan's variants, so there's one entry per benefit rather than one
+ * per variant.
+ *
+ * For memberships the member already owns, the equivalent mapping is
+ * `ExistingMembership.coveredLineItems`, which needs no `benefitId` because a membership is a single
+ * benefit.
  */
 interface LineItemCoverage {
     /**
-     * The benefit that covers the line item, as returned in `Benefit.benefit_id`.
+     * ID of the benefit that covers the line item, as returned in `Benefit.benefitId`.
+     *
+     * Identifies a benefit within its plan, and repeats across that plan's pricing variants.
      * @minLength 1
      * @maxLength 200
      */
     benefitId?: string;
     /**
-     * The line item this benefit covers.
+     * ID of the line item this benefit covers.
      * @minLength 1
      * @maxLength 100
      */
     lineItemId?: string;
     /**
-     * The amount to redeem from the benefit's `limited_quota.remaining` value for this item.
-     * Always 0 for an unlimited benefit (nothing is decremented).
+     * Amount deducted from the benefit's `limitedQuota.remaining` value when this line item is redeemed.
+     *
+     * Always `0` for an unlimited benefit, which decrements nothing.
      */
     redemptionCost?: number;
 }
@@ -4370,4 +4475,4 @@ declare function deleteCart(_id: string): Promise<void>;
  */
 declare function removeBusinessLocation(_id: string): Promise<NonNullablePaths<RemoveBusinessLocationResponse, `cart.lineItems` | `cart.lineItems.${number}.quantity` | `cart.lineItems.${number}.catalogReference.catalogItemId` | `cart.lineItems.${number}.catalogReference.appId` | `cart.lineItems.${number}.productName.original` | `cart.lineItems.${number}.price.amount` | `cart.lineItems.${number}.price.convertedAmount` | `cart.lineItems.${number}.price.formattedAmount` | `cart.lineItems.${number}.price.formattedConvertedAmount` | `cart.lineItems.${number}.availability.status` | `cart.lineItems.${number}.physicalProperties.shippable` | `cart.lineItems.${number}.itemType.preset` | `cart.lineItems.${number}.itemType.custom` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.frequency` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.autoRenewal` | `cart.lineItems.${number}.subscriptionOptionInfo.subscriptionSettings.enableCustomerCancellation` | `cart.lineItems.${number}.subscriptionOptionInfo.title.original` | `cart.lineItems.${number}.subscriptionOptionInfo.description.original` | `cart.lineItems.${number}.paymentOption` | `cart.lineItems.${number}.priceDescription.original` | `cart.lineItems.${number}.selectedMembership._id` | `cart.lineItems.${number}.selectedMembership.appId` | `cart.lineItems.${number}.customLineItem` | `cart.lineItems.${number}.priceUndetermined` | `cart.lineItems.${number}.fixedQuantity` | `cart.lineItems.${number}.catalogOverrideFields.paymentOption.value` | `cart.lineItems.${number}.savePaymentMethod` | `cart.lineItems.${number}.taxableAddress.addressType` | `cart.lineItems.${number}.membersOnly` | `cart.buyerInfo.visitorId` | `cart.buyerInfo.memberId` | `cart.buyerInfo.userId` | `cart.currency` | `cart.conversionCurrency` | `cart.weightUnit` | `cart.appliedDiscounts` | `cart.appliedDiscounts.${number}.coupon._id` | `cart.appliedDiscounts.${number}.coupon.code` | `cart.contactInfo.address.streetAddress.number` | `cart.contactInfo.address.streetAddress.name` | `cart.contactInfo.contactDetails.vatId._id` | `cart.contactInfo.contactDetails.vatId.type` | `cart.selectedShippingOption.code` | `cart.paymentCurrency`, 5>>;
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddToCartApplicationErrors, type AddToCartOptions, type AddToCartRequest, type AddToCartResponse, type AddToCurrentCartAndEstimateTotalsRequest, type AddToCurrentCartRequest, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, type AggregatedTaxBreakdown, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, type AppliedDiscountDiscountTypeWithLiterals, type AutoTaxFallbackCalculationDetails, BalanceType, type BalanceTypeWithLiterals, type BaseEventMetadata, type Benefit, type BenefitQuotaOneOf, type BillingSettings, type BuyerInfo, type BuyerInfoIdOneOf, type CalculatedItemModifier, type CalculatedLineItem, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type Cart, type CartCreatedEnvelope, type CartDeletedEnvelope, type CartDiscount, type CartDiscountDiscountSourceOneOf, type CartUpdatedEnvelope, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type Coupon, type CoveredLineItem, type CreateCartApplicationErrors, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutApplicationErrors, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutOptions, type CreateCheckoutRequest, type CreateCheckoutResponse, type CustomLineItem, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeliveryAllocation, type DeliveryLogistics, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EstimateCurrentCartTotalsRequest, type EstimateTotalsOptions, type EstimateTotalsRequest, type EstimateTotalsResponse, type EventMetadata, type ExistingMembership, type ExtendedFields, FallbackReason, type FallbackReasonWithLiterals, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartByCheckoutIdRequest, type GetCartByCheckoutIdResponse, type GetCartRequest, type GetCartResponse, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardCalculationError, type Group, type HostSelectedMembership, type IdentificationData, type IdentificationDataIdOneOf, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemAvailabilityStatusWithLiterals, type ItemCombination, type ItemCombinationLineItem, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LimitedQuota, LimitedQuotaType, type LimitedQuotaTypeWithLiterals, type LineItem, type LineItemAdded, type LineItemCoverage, type LineItemDiscount, type LineItemPricesData, type LineItemQuantityUpdate, ManualCalculationReason, type ManualCalculationReasonWithLiterals, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MerchantDiscount, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type OtherCharge, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, PlatformFeeChargeType, type PlatformFeeChargeTypeWithLiterals, type Policy, type PriceDescription, type PriceSummary, type ProductName, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type PurchasablePlan, QuotaType, type QuotaTypeWithLiterals, RateType, type RateTypeWithLiterals, type Region, type RemoveBusinessLocationRequest, type RemoveBusinessLocationResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type SelectedShippingOption, type ServiceProperties, Severity, type SeverityWithLiterals, type ShippingInformation, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCartApplicationErrors, type UpdateCartOptions, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, type UpdateLineItemsQuantityRequest, type UpdateLineItemsQuantityResponse, type V1Coupon, type V1DiscountRule, type V1DiscountRuleName, type V1ItemModifier, type V1Membership, type V1MerchantDiscount, type V1ModifierGroup, type ValidatedExistingMemberships, type ValidatedPurchasablePlans, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addToCart, createCart, createCheckout, deleteCart, estimateTotals, getCart, getCartByCheckoutId, onCartCreated, onCartDeleted, onCartUpdated, removeBusinessLocation, removeCoupon, removeLineItems, updateCart, updateLineItemsQuantity };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddToCartApplicationErrors, type AddToCartOptions, type AddToCartRequest, type AddToCartResponse, type AddToCurrentCartAndEstimateTotalsRequest, type AddToCurrentCartRequest, type AdditionalFee, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, type AggregatedTaxBreakdown, type ApplicableLineItems, type ApplicationError, type AppliedDiscount, type AppliedDiscountDiscountSourceOneOf, AppliedDiscountDiscountType, type AppliedDiscountDiscountTypeWithLiterals, type AutoTaxFallbackCalculationDetails, BalanceType, type BalanceTypeWithLiterals, type BaseEventMetadata, type Benefit, type BenefitQuotaOneOf, type BillingSettings, type BuyerInfo, type BuyerInfoIdOneOf, type CalculatedItemModifier, type CalculatedLineItem, type CalculationErrors, type CalculationErrorsShippingCalculationErrorOneOf, type Carrier, type CarrierError, type CarrierErrors, type CarrierServiceOption, type Cart, type CartCreatedEnvelope, type CartDeletedEnvelope, type CartDiscount, type CartDiscountDiscountSourceOneOf, type CartUpdatedEnvelope, type CatalogOverrideFields, type CatalogReference, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type Coupon, type CoveredLineItem, type CreateCartApplicationErrors, type CreateCartOptions, type CreateCartRequest, type CreateCartResponse, type CreateCheckoutApplicationErrors, type CreateCheckoutFromCurrentCartRequest, type CreateCheckoutOptions, type CreateCheckoutRequest, type CreateCheckoutResponse, type CustomLineItem, type CyclePriceOverride, type DeleteCartRequest, type DeleteCartResponse, type DeleteCurrentCartRequest, type DeliveryAllocation, type DeliveryLogistics, type DeliveryTimeSlot, type Description, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type Details, type DetailsKindOneOf, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EstimateCurrentCartTotalsRequest, type EstimateTotalsOptions, type EstimateTotalsRequest, type EstimateTotalsResponse, type EventMetadata, type ExistingMembership, type ExtendedFields, FallbackReason, type FallbackReasonWithLiterals, type FieldViolation, FileType, type FileTypeWithLiterals, type FocalPoint, type FreeTrialPeriod, type FullAddressContactDetails, type GetCartByCheckoutIdRequest, type GetCartByCheckoutIdResponse, type GetCartRequest, type GetCartResponse, type GetCurrentCartRequest, type GetCurrentCartResponse, type GiftCard, type GiftCardCalculationError, type Group, type HostSelectedMembership, type IdentificationData, type IdentificationDataIdOneOf, type InvalidMembership, type ItemAvailabilityInfo, ItemAvailabilityStatus, type ItemAvailabilityStatusWithLiterals, type ItemCombination, type ItemCombinationLineItem, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LimitedQuota, LimitedQuotaType, type LimitedQuotaTypeWithLiterals, type LineItem, type LineItemAdded, type LineItemCoverage, type LineItemDiscount, type LineItemPricesData, type LineItemQuantityUpdate, ManualCalculationReason, type ManualCalculationReasonWithLiterals, type Membership, type MembershipName, type MembershipOptions, type MembershipPaymentCredits, type MerchantDiscount, type MessageEnvelope, type ModifierGroup, type MultiCurrencyPrice, NameInLineItem, type NameInLineItemWithLiterals, NameInOther, type NameInOtherWithLiterals, type Other, type OtherCharge, type PaymentOption, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, PlatformFeeChargeType, type PlatformFeeChargeTypeWithLiterals, type Policy, type PriceDescription, type PriceSummary, type ProductName, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type PurchasablePlan, QuotaType, type QuotaTypeWithLiterals, RateType, type RateTypeWithLiterals, type Region, type RemoveBusinessLocationRequest, type RemoveBusinessLocationResponse, type RemoveCouponFromCurrentCartRequest, type RemoveCouponRequest, type RemoveCouponResponse, type RemoveLineItemsFromCurrentCartRequest, type RemoveLineItemsRequest, type RemoveLineItemsResponse, type RestoreInfo, RuleType, type RuleTypeWithLiterals, type Scope, type SecuredMedia, type SelectedCarrierServiceOption, type SelectedCarrierServiceOptionOtherCharge, type SelectedCarrierServiceOptionPrices, type SelectedMembership, type SelectedMemberships, type SelectedShippingOption, type ServiceProperties, Severity, type SeverityWithLiterals, type ShippingInformation, type ShippingOption, type ShippingPrice, type ShippingRegion, type StreetAddress, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionOptionInfo, type SubscriptionSettings, SuggestedFix, type SuggestedFixWithLiterals, type SystemError, type Target, type TargetLineItem, type TargetTargetTypeOneOf, type TaxBreakdown, type TaxCalculationDetails, type TaxCalculationDetailsCalculationDetailsOneOf, type TaxRateBreakdown, type TaxSummary, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type Title, type TranslatableString, type UpdateCartApplicationErrors, type UpdateCartOptions, type UpdateCartRequest, type UpdateCartResponse, type UpdateCurrentCartLineItemQuantityRequest, type UpdateLineItemsQuantityRequest, type UpdateLineItemsQuantityResponse, type V1Coupon, type V1DiscountRule, type V1DiscountRuleName, type V1ItemModifier, type V1Membership, type V1MerchantDiscount, type V1ModifierGroup, type ValidatedExistingMemberships, type ValidatedPurchasablePlans, type ValidationError, type VatId, VatType, type VatTypeWithLiterals, type Violation, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, addToCart, createCart, createCheckout, deleteCart, estimateTotals, getCart, getCartByCheckoutId, onCartCreated, onCartDeleted, onCartUpdated, removeBusinessLocation, removeCoupon, removeLineItems, updateCart, updateLineItemsQuantity };